diff options
| author | Gustav Sörnäs <gustav@sornas.net> | 2021-06-15 12:50:01 +0200 |
|---|---|---|
| committer | Gustav Sörnäs <gustav@sornas.net> | 2021-06-15 12:50:01 +0200 |
| commit | ed4b641f6d4816325aa07e0f13b6132c1c4dafa2 (patch) | |
| tree | b0ebd0d3af041bc1a3b940a131260f77a63ee53b /mumlib/src/lib.rs | |
| parent | 64978fa17b6e0882d6bacb6e626b0bc9ead2c81d (diff) | |
| download | mum-ed4b641f6d4816325aa07e0f13b6132c1c4dafa2.tar.gz | |
more mumlib doc just because
Diffstat (limited to 'mumlib/src/lib.rs')
| -rw-r--r-- | mumlib/src/lib.rs | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/mumlib/src/lib.rs b/mumlib/src/lib.rs index 4b302e3..679db8d 100644 --- a/mumlib/src/lib.rs +++ b/mumlib/src/lib.rs @@ -1,3 +1,7 @@ +//! Shared items for crates that want to communicate with mumd and/or mumctl. + +// #![warn(missing_docs)] + pub mod command; pub mod config; pub mod error; @@ -8,11 +12,15 @@ pub use error::Error; use colored::*; use log::*; +/// The default file path to use for the socket. pub const SOCKET_PATH: &str = "/tmp/mumd"; /// The default mumble port. pub const DEFAULT_PORT: u16 = 64738; +/// Setup a minimal fern logger. +/// +/// Format: `LEVEL [yyyy-mm-dd][HH:MM:SS] FILE:LINE MESSAGE` pub fn setup_logger<T: Into<fern::Output>>(target: T, color: bool) { fern::Dispatch::new() .format(move |out, message, record| { |