aboutsummaryrefslogtreecommitdiffstats
path: root/mumlib/src/lib.rs
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2021-06-19 18:38:17 +0200
committerGustav Sörnäs <gustav@sornas.net>2021-06-19 18:38:17 +0200
commitb2e9021341794ab52edcf4598c8d454515f758c4 (patch)
treeb61bacf7768c7edd781a50ae8006dcda5ec3d842 /mumlib/src/lib.rs
parentad0ee3950aa5a54a3617d6f028ab90d4c79553f0 (diff)
parentc774aadf26b7ecc08a548ed5d781ea3fc5eac1b2 (diff)
downloadmum-b2e9021341794ab52edcf4598c8d454515f758c4.tar.gz
Merge remote-tracking branch 'origin/documentation'
Diffstat (limited to 'mumlib/src/lib.rs')
-rw-r--r--mumlib/src/lib.rs10
1 files changed, 10 insertions, 0 deletions
diff --git a/mumlib/src/lib.rs b/mumlib/src/lib.rs
index 9b7d686..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,9 +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| {