Struct malachi::Command

pub struct Command(_);

A compiled command that can be used to match text.

Implementations

impl Command

pub fn new(s: &str) -> Result<Self>

Compiles a command.

pub fn segments(&self) -> Iter<'_, Segment>

Returns an iterator over the Segments that make up self.

impl Command

pub fn get_matches<'c, 't>(&'c self, s: &'t str) -> Option<Args<'c, 't>>

Match this Command to the given text, returning captures if any.

pub fn has_prefix(&self, s: &str) -> bool

Returns true if the command matches the string at least partially. This is equivalent to a command composed of only the first Segment of self matching the string and checking that it is Some.

Examples

let cmd = malachi::Command::new("?eval <code: starts('```'), ends('```')>")?;

// This text won't match but has the correct prefix.
let text = "?eval 4";

assert_eq!(cmd.get_matches(text), None);
assert!(cmd.has_prefix(text));

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Hash for Command

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Command> for Command

fn eq(&self, other: &Command) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Command) -> bool

This method tests for !=.

impl Eq for Command

impl StructuralEq for Command

impl StructuralPartialEq for Command