Struct twilight_command_parser::config::CommandParserConfig

pub struct CommandParserConfig<'a> { /* fields omitted */ }

Configuration for a Parser.

Implementations

impl<'a> CommandParserConfig<'a>

pub const fn new() -> Self

Creates a fresh default configuration with no commands or prefixes.

pub fn commands(&self) -> Commands<'_>

Returns an iterator of immutable references to the commands.

pub fn commands_mut(&mut self) -> CommandsMut<'_>

Returns an iterator of mutable references to the commands.

Use the add_command and remove_command methods for an easier way to manage commands.

pub fn prefixes(&self) -> Prefixes<'_>

Returns an iterator of immutable references to the prefixes.

Use the add_prefix and remove_prefix methods for an easier way to manage prefixes.

pub fn prefixes_mut(&'a mut self) -> PrefixesMut<'a>

Returns an iterator of mutable references to the prefixes.

pub fn add_command(
    &mut self,
    name: impl Into<String>,
    case_sensitive: bool
) -> bool

Add a command to the list of commands.

Examples

Add a case-sensitive “ping” command:

use twilight_command_parser::CommandParserConfig;

let mut config = CommandParserConfig::new();
config.add_command("ping", true);
assert_eq!(1, config.commands().len());

pub fn remove_command(&mut self, command: impl AsRef<str>)

Removes a command from the list of commands.

Any commands that would match the command provided are removed.

Examples

use twilight_command_parser::CommandParserConfig;

let mut config = CommandParserConfig::new();
config.add_command("ping", true);
config.add_command("PING", false);
assert_eq!(2, config.commands().len());

// Now remove it and verify that there are no commands.
config.remove_command("ping");
assert_eq!(config.commands().len(), 0);

pub fn add_prefix(&mut self, prefix: impl Into<Cow<'a, str>>) -> bool

Adds a prefix to the list of prefixes.

Examples

use twilight_command_parser::CommandParserConfig;

let mut config = CommandParserConfig::new();
config.add_prefix("!");
assert_eq!(1, config.prefixes().len());

pub fn remove_prefix(
    &mut self,
    prefix: impl Into<Cow<'a, str>>
) -> Option<Cow<'a, str>>

Removes a prefix from the list of prefixes.

Returns whether a prefix with the name was removed.

Examples

use twilight_command_parser::CommandParserConfig;

let mut config = CommandParserConfig::new();
config.add_prefix("!");
config.add_prefix("~");
assert_eq!(2, config.prefixes().len());

// Now remove one and verify that there is only 1 prefix.
config.remove_prefix("!");
assert_eq!(1, config.prefixes().len());

Trait Implementations

impl<'a> Clone for CommandParserConfig<'a>

fn clone(&self) -> CommandParserConfig<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CommandParserConfig<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for CommandParserConfig<'a>

fn default() -> CommandParserConfig<'a>

Returns the “default value” for a type.