Struct papyrus::cmds::CommandBuilder

pub struct CommandBuilder<R> { /* fields omitted */ }

The persistent Builder structure to construct a Commander command tree. See module level documentation for more information.

Methods

impl Builder<()>

pub fn default_config(root_name: &str) -> Builder<()>

Initialise a Builder instance with the given root name.

impl<R> Builder<R>

pub fn new(root_name: &str) -> Builder<R>

Initialise new Builder instance with no configuration.

Trait Implementations

impl<R> BuilderChain<R> for Builder<R>

fn begin_class<H>(
    self,
    name: &str,
    help_msg: H
) -> Result<Builder<R>, BuildError> where
    H: Into<CmdStr>, 

Start a new nested class. If the name already exists a BuildError will be returned.

fn end_class(self) -> Result<Builder<R>, BuildError>

Close a class and move to it's parent. If no parent exists (this function is called on the root), a BuildError will be returned.

fn root(self) -> Result<Builder<R>, BuildError>

Navigates to the root class, closing out the classes as it goes.

fn add_action<H, F>(
    self,
    name: &str,
    help_msg: H,
    closure: F
) -> Result<Builder<R>, BuildError> where
    F: FnMut(&mut dyn Write, &[&str]) -> R + Send + 'static,
    H: Into<CmdStr>, 

Add an action. The closure type gives the arguments after the action command as an array of strings.

fn into_commander(self) -> Result<Commander<R>, BuildError>

Finishes the construction of the command tree and returns the build Commander.

impl<R> Debug for Builder<R> where
    R: Debug, 

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

Formats the value using the given formatter.

impl<R> PartialEq<Builder<R>> for Builder<R> where
    R: PartialEq<R>, 

fn eq(&self, other: &Builder<R>) -> bool

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

fn ne(&self, other: &Builder<R>) -> bool

This method tests for !=.

impl<R> StructuralPartialEq for Builder<R>