Struct cmdr::ScopeCmdDescription

pub struct ScopeCmdDescription { /* fields omitted */ }

All information about a command method in one handy struct

Implementations

impl ScopeCmdDescription

pub fn new(name: String, alias: Vec<String>, help_text: Option<String>) -> Self

Construct a CmdMethod from a command name and a command closure

pub fn name(&self) -> &str

Name accessor method

pub fn help_text(&self) -> &Option<String>

Help text accessor method

pub fn aliases(&self) -> impl Iterator<Item = &String>

An iterator of all aliasses for this command

pub fn handles(&self, command: &str) -> bool

Checks name or alias to see if a command can be handled.

Trait Implementations

impl<'a> Debug for ScopeCmdDescription

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

Formats the value using the given formatter.