Type Definition cmdtree::builder::BuilderResult

type BuilderResult<'a, R> = Result<Builder<'a, R>, BuildError>;

The common result of BuilderChain functions.

Trait Implementations

impl<'a, R> BuilderChain<'a, R> for BuilderResult<'a, R>

fn begin_class(self, name: &str, help_msg: &'a str) -> BuilderResult<'a, R>

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

fn end_class(self) -> BuilderResult<'a, R>

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) -> BuilderResult<'a, R>

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

fn add_action<F: FnMut(&mut dyn Write, &[&str]) -> R + Send + 'a>(
    self,
    name: &str,
    help_msg: &'a str,
    closure: F
) -> BuilderResult<'a, R>

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

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

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