[−][src]Struct twilight_command_parser::Parser
A struct to parse prefixes, commands, and arguments out of messages.
While parsing, the parser takes into account the configuration that it was
configured with. This configuration is mutable during runtime via the
Parser::config_mut
method.
After parsing, you're given an optional Command
: a struct representing a
command and its relevant information. Refer to its documentation for more
information.
Examples
Using a parser configured with the commands "echo"
and "ping"
and the
prefix "!"
, parse the message "!echo foo bar baz":
use twilight_command_parser::{Command, CommandParserConfig, Parser}; let mut config = CommandParserConfig::new(); config.add_command("echo", false); config.add_command("ping", false); config.add_prefix("!"); let parser = Parser::new(config); if let Some(command) = parser.parse("!echo foo bar baz") { match command { Command { name: "echo", arguments, .. } => { let content = arguments.as_str(); println!("Got a request to echo `{}`", content); }, Command { name: "ping", .. } => { println!("Got a ping request"); }, _ => {}, } }
Implementations
impl<'a> Parser<'a>
[src]
pub fn new(config: impl Into<CommandParserConfig<'a>>) -> Self
[src]
Creates a new parser from a given configuration.
pub fn config(&self) -> &CommandParserConfig<'a>
[src]
Returns an immutable reference to the configuration.
pub fn config_mut(&mut self) -> &mut CommandParserConfig<'a>
[src]
Returns a mutable reference to the configuration.
pub fn parse(&'a self, buf: &'a str) -> Option<Command<'a>>
[src]
Parses a command out of a buffer.
If a configured prefix and command are in the buffer, then some
Command
is returned with them and a lazy iterator of the
argument list.
If a matching prefix or command weren't found, then None
is returned.
Refer to the struct-level documentation on how to use this.
pub fn parse_with_prefix(
&'a self,
prefix: &'a str,
buf: &'a str
) -> Option<Command<'a>>
[src]
&'a self,
prefix: &'a str,
buf: &'a str
) -> Option<Command<'a>>
Parse a command out of a buffer with a specific prefix.
Instead of using the list of set prefixes, give a specific prefix to parse the message, this can be used to have a kind of dynamic prefixes.
Example
let mut config = CommandParserConfig::new(); config.add_prefix("!"); config.add_command("echo", false); let parser = Parser::new(config); let command = parser.parse_with_prefix("=", "=echo foo")?; assert_eq!("=", command.prefix); assert_eq!("echo", command.name);
Trait Implementations
impl<'a> Clone for Parser<'a>
[src]
impl<'a> Debug for Parser<'a>
[src]
impl<'a, T: Into<CommandParserConfig<'a>>> From<T> for Parser<'a>
[src]
Auto Trait Implementations
impl<'a> RefUnwindSafe for Parser<'a>
[src]
impl<'a> Send for Parser<'a>
[src]
impl<'a> Sync for Parser<'a>
[src]
impl<'a> Unpin for Parser<'a>
[src]
impl<'a> UnwindSafe for Parser<'a>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,