diff --git a/pnmixerlib/index.html b/pnmixerlib/index.html
index 3efaca396..509b6d0c4 100644
--- a/pnmixerlib/index.html
+++ b/pnmixerlib/index.html
@@ -48,8 +48,36 @@
[−]
- [src]
-
+ [src]
+PNMixer-rs is a mixer for the system tray.
+
+
+
The lowest level part of the code is the sound backend. Only Alsa is supported
+at the moment, but more backends may be added in the future.
+
+
The backend is hidden behind a frontend, defined in audio.rs. Only audio.rs
+deals with audio backends. This means that the whole of the code is blissfully
+ignorant of the audio backend in use.
+
+
audio.rs is also in charge of emitting signals whenever a change happens.
+This means that PNMixer-rs design is quite signal-oriented, so to say.
+
+
The ui code is nothing fancy. Each ui element...
+
+
+- is defined in a single file
+- strives to be standalone
+- accesses the sound system with function calls
+- listens to signals from the audio subsystem to update its appearance
+
+
+
There's something you should keep in mind. Audio on a computer is a shared
+resource. PNMixer-rs isn't the only one that can change it. At any moment the
+audio volume may be modified by someone else, and we must update the ui
+accordingly. So listening to changes from the audio subsystem (and therefore
+having a signal-oriented design) is the most obvious solution to solve that
+problem.
+
@@ -178,35 +206,32 @@ in the binary and decodes it.
| try_e |
-
- |
-
-
- | try_er |
-
-
+ Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise print an error and exit the program.
|
| try_r |
-
+ Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise return from the function with the given value.
|
| try_w |
-
+ Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise print a warning and return () from the function.
|
| try_wr |
-
+ Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise print a warning and return from the function with the given value.
|
diff --git a/pnmixerlib/macro.try_e.html b/pnmixerlib/macro.try_e.html
index 32c708f49..8660ec7c3 100644
--- a/pnmixerlib/macro.try_e.html
+++ b/pnmixerlib/macro.try_e.html
@@ -48,14 +48,16 @@
[−]
- [src]
+ [src]
macro_rules! try_e {
($expr:expr) => { ... };
- ($expr:expr, $fmt:expr, $($arg:tt)+) => { ... };
($expr:expr, $fmt:expr) => { ... };
+ ($expr:expr, $fmt:expr, $($arg:tt)+) => { ... };
}
-
+Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise print an error and exit the program.
+
macro_rules! try_r {
($expr:expr, $ret:expr) => { ... };
}
-
+Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise return from the function with the given value.
+
macro_rules! try_w {
($expr:expr) => { ... };
($expr:expr, $fmt:expr, $($arg:tt)+) => { ... };
($expr:expr, $fmt:expr) => { ... };
}
-
+Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise print a warning and return () from the function.
+
macro_rules! try_wr {
($expr:expr, $ret:expr) => { ... };
($expr:expr, $ret:expr, $fmt:expr) => { ... };
($expr:expr, $ret:expr, $fmt:expr, $($arg:tt)+) => { ... };
}
-
+Try to unwrap a Result<T, E>. If there is a value T, yield it,
+otherwise print a warning and return from the function with the given value.
+
#![allow(missing_docs)]
@@ -183,6 +176,8 @@
#[macro_export]
+
+
macro_rules! try_w {
($expr:expr) => {
try_wr!($expr, ())
@@ -197,6 +192,8 @@
#[macro_export]
+
+
macro_rules! try_wr {
($expr:expr, $ret:expr) => (match $expr {
::std::result::Result::Ok(val) => val,
@@ -225,6 +222,8 @@
#[macro_export]
+
+
macro_rules! try_r {
($expr:expr, $ret:expr) => (match $expr {
::std::result::Result::Ok(val) => val,
@@ -235,31 +234,18 @@
}
-
#[macro_export]
+
+
macro_rules! try_e {
- ($expr:expr) => {
- try_er!($expr, ())
- };
- ($expr:expr, $fmt:expr, $($arg:tt)+) => {
- try_er!($expr, (), $fmt, $(arg)+)
- };
- ($expr:expr, $fmt:expr) => {
- try_er!($expr, (), $fmt)
- }
-}
-
-
-#[macro_export]
-macro_rules! try_er {
- ($expr:expr, $ret:expr) => (match $expr {
+ ($expr:expr) => (match $expr {
::std::result::Result::Ok(val) => val,
::std::result::Result::Err(err) => {
error!("{:?}", err);
::std::process::exit(1);
},
});
- ($expr:expr, $ret:expr, $fmt:expr) => (match $expr {
+ ($expr:expr, $fmt:expr) => (match $expr {
::std::result::Result::Ok(val) => val,
::std::result::Result::Err(err) => {
error!("Original error: {:?}", err);
@@ -267,7 +253,7 @@
std::process::exit(1);
},
});
- ($expr:expr, $ret:expr, $fmt:expr, $($arg:tt)+) => (match $expr {
+ ($expr:expr, $fmt:expr, $($arg:tt)+) => (match $expr {
::std::result::Result::Ok(val) => val,
::std::result::Result::Err(err) => {
error!("Original error: {:?}", err);
diff --git a/src/pnmixerlib/lib.rs.html b/src/pnmixerlib/lib.rs.html
index b2948c862..872e846d7 100644
--- a/src/pnmixerlib/lib.rs.html
+++ b/src/pnmixerlib/lib.rs.html
@@ -104,7 +104,65 @@
59
60
61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#![warn(missing_docs)]
#![feature(alloc_system)]