zyl/classics
1
0
Fork 0
mirror of https://github.com/zyllian/classics.git synced 2025-01-18 11:47:14 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

add missing command docs

Browse source
This commit is contained in:
Zoey 2024-04-22 22:06:15 -07:00
parent 19116ee308
commit 98ffb28eb2
No known key found for this signature in database
GPG key ID: 8611B896D1AAFAF2
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/command.rs
View file

@ -21,8 +21,10 @@ pub enum Command<'m> {
} }
impl<'m> Command<'m> { impl<'m> Command<'m> {
/// the prefix for commands
pub const PREFIX: char = '/'; pub const PREFIX: char = '/';
/// parses a command, returning the parsed command or an error to be displayed to the player who sent the command
pub fn parse(input: &'m str) -> Result<Command, String> { pub fn parse(input: &'m str) -> Result<Command, String> {
let (command_name, mut arguments) = input.split_once(' ').unwrap_or((input, "")); let (command_name, mut arguments) = input.split_once(' ').unwrap_or((input, ""));
Ok(match command_name { Ok(match command_name {
@ -36,6 +38,7 @@ impl<'m> Command<'m> {
}) })
} }
/// checks which permissions are required to run this command
pub fn perms_required(&self) -> PlayerType { pub fn perms_required(&self) -> PlayerType {
match self { match self {
Self::Me { .. } => PlayerType::Normal, Self::Me { .. } => PlayerType::Normal,
@ -43,6 +46,7 @@ impl<'m> Command<'m> {
} }
} }
/// gets the next string argument from the command
fn next_string(args: &mut &'m str) -> Result<&'m str, String> { fn next_string(args: &mut &'m str) -> Result<&'m str, String> {
if args.is_empty() { if args.is_empty() {
return Err("Missing argument".to_string()); return Err("Missing argument".to_string());