document command module

src/command/command.rs

@@ -7,6 +7,13 @@ use crate::command::{CommandNew, CommandSet, Parse, ParserError};
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Root level of command.
+///
+/// Every command must be implemented here, either directly or nested inside
+/// a subcommand somewhere.
+///
+/// The parser matches against lowercase string representations of the enum
+/// variants
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum Command {
 	N,

src/command/mod.rs

@@ -1,3 +1,22 @@
+//! Mud commands
+//!
+//! This module contains the command parser and the commands themselves. A
+//! generic interface is provided to make it easier to parse the input, map
+//! it to a function, call that function, and provide help on commands.
+//!
+//! The command parsing is done in such a fashion that only enough characters
+//! to unambiguously desginate a command are needed. That means "lo" will
+//! match "look" as long as there's not a "log". If multiple matches are
+//! found, the first one in alphabetical order is selected. This action may
+//! change in the future.
+//!
+//! The help system isn't implemented yet.
+//!
+//! Each command is to be listed in the `Command` enum, which is the root
+//! level of the commands. It and any subcommands must implement the `Parse`
+//! trait, and if there are subcommands then certain trait methods must be
+//! implemented for the subcommand parsing and matching to function properly.
+
 mod command;
 mod dispatch;
 mod new;

src/command/new/new.rs

@@ -7,10 +7,15 @@ use crate::command::Parse;
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Create new things
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum CommandNew {
+	/// Create a new room
 	Room,
+
+	/// Create a new zone
 	Zone,
+
 	Default,
 }
 

src/command/parse.rs

@@ -7,7 +7,9 @@ use crate::command::ParserError;
 use crate::database::Db;
 use crate::queue::SendQueue;
 
-/// Command parser. Commands consist of the text from the beginning of a string, up to but not
+/// Command parser.
+///
+/// Commands consist of the text from the beginning of a string, up to but not
 /// including the first space character or newline. If a space, that space is removed and the
 /// rest of the string is put into args. If a newline, args will be empty. The command part of the
 /// string is then parsed for a match with the variants of the enum. After that, control is passed

src/command/parser_error.rs

@@ -1,10 +1,15 @@
 use std::error::Error;
 use std::fmt;
 
+/// Errors that may be emitted by the command parser
 #[derive(Debug)]
 pub enum ParserError {
+	/// No command provided
 	Empty,
+
+	/// Unknown command
 	Unknown,
+
 	Default,
 }
 

src/command/set/player/name.rs

@@ -6,12 +6,12 @@ use crate::queue::SendQueue;
 use crate::{try_option_send_error, try_send_error};
 
 impl CommandSetPlayer {
+	/// Set the player's name
 	pub fn dispatch_name(&self, args: String, token: Token, db: &mut Db) -> SendQueue {
 		let mut player = try_option_send_error!(token, db.get_connected_player(token));
 
 		let new_name = args.trim();
 		if new_name.is_empty() {
-			//return SendQueue::from_string(token, "Name can't be empty")
 			return SendQueue(vec![(token, "Name can't be empty".into(), true)].into());
 		}
 

src/command/set/player/player.rs

@@ -7,9 +7,12 @@ use crate::command::Parse;
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Modify player properties
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum CommandSetPlayer {
+	/// Set the player's name
 	Name,
+
 	Default,
 }
 

src/command/set/room/description/delete.rs

@@ -8,7 +8,7 @@ use crate::queue::SendQueue;
 use crate::{try_option_send_error, try_send, try_send_error};
 
 impl CommandSetRoomDescription {
-	/// Set the specified line in the description to the specified text.
+	/// Delete the specified line from the description.
 	pub fn dispatch_delete(&self, args: String, token: Token, db: &mut Db) -> SendQueue {
 		// make sure something was provided
 		if args.is_empty() {

src/command/set/room/description/description.rs

@@ -7,10 +7,15 @@ use crate::command::Parse;
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Modify the room description
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum CommandSetRoomDescription {
+	/// Delete a line
 	Delete,
+
+	/// Set a line
 	Set,
+
 	Default,
 }
 

src/command/set/room/name.rs

@@ -6,6 +6,7 @@ use crate::queue::SendQueue;
 use crate::{try_option_send_error, try_send_error};
 
 impl CommandSetRoom {
+	/// Change the room name
 	pub fn dispatch_name(&self, args: String, token: Token, db: &mut Db) -> SendQueue {
 		let player = try_option_send_error!(token, db.get_connected_player(token));
 

src/command/set/room/room.rs

@@ -7,10 +7,15 @@ use crate::command::{CommandSetRoomDescription, Parse, ParserError};
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Set room properties
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum CommandSetRoom {
+	/// Change the room description
 	Description(CommandSetRoomDescription),
+
+	/// Set the room name
 	Name,
+
 	Default,
 }
 

src/command/set/set.rs

@@ -7,11 +7,18 @@ use crate::command::{CommandSetPlayer, CommandSetRoom, CommandSetZone, Parse, Pa
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Set various options
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum CommandSet {
+	/// Player options
 	Player(CommandSetPlayer),
+
+	/// Room options
 	Room(CommandSetRoom),
+
+	/// Zone options
 	Zone(CommandSetZone),
+
 	Default,
 }
 

src/command/set/zone/name.rs

@@ -6,6 +6,7 @@ use crate::queue::SendQueue;
 use crate::{try_option_send_error, try_send_error};
 
 impl CommandSetZone {
+	/// Change the zone name
 	pub fn dispatch_name(&self, args: String, token: Token, db: &mut Db) -> SendQueue {
 		let player = try_option_send_error!(token, db.get_connected_player(token));
 

src/command/set/zone/zone.rs

@@ -7,9 +7,12 @@ use crate::command::Parse;
 use crate::database::Db;
 use crate::queue::SendQueue;
 
+/// Change zone properties
 #[derive(Clone, Debug, Display, EnumIter, Eq, Ord, PartialEq, PartialOrd)]
 pub enum CommandSetZone {
+	/// Change the name of the zone
 	Name,
+
 	Default,
 }