SubCommand

Struct SubCommand

pub struct SubCommand<'a> { /* private fields */ }

Expand description

A sub-command line parser.

Used with SubCommandParser::command.

Implementations§

impl<'a> SubCommand<'a>

pub fn about(self, description: impl Into<String>) -> Self

Document the about message for this sub-command. If repeated, only the final help message will apply.

An about message documents the sub-command in full sentence/paragraph format. We recommend allowing blarg to format this field (ex: it is not recommended to use line breaks '\n').

See SubCommandParser::command for usage.

pub fn add<T>(self, parameter: Parameter<'a, T>) -> Self

Add an argument/option to the sub-command.

The order of argument parameters corresponds to their positional order during parsing. The order of option parameters does not affect the sub-command parser semantics.

See SubCommandParser::command for usage.

Auto Trait Implementations§

impl<'a> Freeze for SubCommand<'a>

impl<'a> !RefUnwindSafe for SubCommand<'a>

impl<'a> !Send for SubCommand<'a>

impl<'a> !Sync for SubCommand<'a>

impl<'a> Unpin for SubCommand<'a>

impl<'a> !UnwindSafe for SubCommand<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.