Type Definition cmdtree::builder::BuilderResult

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

The common result of BuilderChain functions.

Trait Implementations

impl<R> BuilderChain<R> for BuilderResult<R>

fn begin_class<H: Into<CmdStr>>(
    self,
    name: &str,
    help_msg: H
) -> BuilderResult<R>

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

fn end_class(self) -> BuilderResult<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<R>

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
) -> BuilderResult<R> where
    H: Into<CmdStr>,
    F: FnMut(&mut dyn Write, &[&str]) -> R + Send + 'static, 

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<R>, BuildError>

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