Struct cmdtree::builder::Builder

pub struct Builder<'a, R> { /* fields omitted */ }

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

Methods

impl<'a> Builder<'a, ()>

pub fn default_config(root_name: &str) -> Self

Initialise a Builder instance with the given root name.

impl<'a, R> Builder<'a, R>

pub fn new(root_name: &str) -> Self

Initialise new Builder instance with no configuration.

Trait Implementations

impl<'a, R> BuilderChain<'a, R> for Builder<'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>(
    self,
    name: &str,
    help_msg: &'a str,
    closure: F
) -> BuilderResult<'a, R> where
    F: FnMut(&mut dyn Write, &[&str]) -> R + Send + 'a, 

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.

impl<'a, R: PartialEq> PartialEq<Builder<'a, R>> for Builder<'a, R>

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

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

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

This method tests for !=.

impl<'a, R: Debug> Debug for Builder<'a, R>

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

Formats the value using the given formatter.