From eee62e0892b1247ce321cd30747ab90d58f49732 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= <gustav@sornas.net>
Date: Wed, 13 Jan 2021 23:19:22 +0100
Subject: document mumlib

---
 mumlib/src/command.rs | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

(limited to 'mumlib/src/command.rs')

diff --git a/mumlib/src/command.rs b/mumlib/src/command.rs
index 8cb7cb9..642c8b9 100644
--- a/mumlib/src/command.rs
+++ b/mumlib/src/command.rs
@@ -1,3 +1,7 @@
+//! [Command]s can be sent from a controller to mumd who might respond with a
+//! [CommandResponse]. The commands and their responses are serializable and
+//! can be sent in any way you want.
+
 use crate::state::{Channel, Server};
 
 use chrono::NaiveDateTime;
@@ -56,29 +60,51 @@ impl fmt::Display for MumbleEventKind {
     }
 }
 
+/// Sent by a controller to mumd who might respond with a [CommandResponse]. Not
+/// all commands receive a response.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub enum Command {
+    /// No response.
     ChannelJoin {
         channel_identifier: String,
     },
+
+    /// Response: [CommandResponse::ChannelList].
     ChannelList,
+
+    /// Force reloading of config file from disk. No response.
     ConfigReload,
+    /// Response: [CommandResponse::DeafenStatus]. Toggles if None.
     DeafenSelf(Option<bool>),
     Events {
         block: bool
     },
+    /// Set the outgoing audio volume (i.e. from you to the server). No response.
     InputVolumeSet(f32),
+
+    /// Response: [CommandResponse::MuteStatus]. Toggles if None.
     MuteOther(String, Option<bool>),
+
+    /// Response: [CommandResponse::MuteStatus]. Toggles if None.
     MuteSelf(Option<bool>),
+
+    /// Set the master incoming audio volume (i.e. from the server to you).
+    /// No response.
     OutputVolumeSet(f32),
+
     PastMessages {
         block: bool,
     },
+
+    /// Response: [CommandResponse::Pong]. Used to test existance of a
+    /// mumd-instance.
     Ping,
+
     SendMessage {
         message: String,
         targets: MessageTarget,
     },
+    /// Connect to the specified server. Response: [CommandResponse::ServerConnect].
     ServerConnect {
         host: String,
         port: u16,
@@ -86,43 +112,61 @@ pub enum Command {
         password: Option<String>,
         accept_invalid_cert: bool,
     },
+
+    /// No response.
     ServerDisconnect,
+
+    /// Send a server status request via UDP (e.g. not requiring a TCP connection).
+    /// Response: [CommandResponse::ServerStatus].
     ServerStatus {
         host: String,
         port: u16,
     },
+
+    /// Response: [CommandResponse::Status].
     Status,
+
+    /// No response.
     UserVolumeSet(String, f32),
 }
 
+/// A response to a sent [Command].
 #[derive(Debug, Deserialize, Serialize)]
 pub enum CommandResponse {
     ChannelList {
         channels: Channel,
     },
+
     DeafenStatus {
         is_deafened: bool,
     },
+
     Event {
         event: MumbleEvent,
     },
+
     MuteStatus {
         is_muted: bool,
     },
+
     PastMessage {
         message: (NaiveDateTime, String, String),
     },
+
     Pong,
+
     ServerConnect {
         welcome_message: Option<String>,
         server_state: Server,
     },
+
     ServerStatus {
         version: u32,
         users: u32,
         max_users: u32,
         bandwidth: u32,
     },
+
     Status {
         server_state: Server,
     },
-- 
cgit v1.2.1