Skip to main content

CommandBuilder

Struct CommandBuilder 

Source
pub struct CommandBuilder { /* private fields */ }
Expand description

Builder for a single command’s spec.

Implementations§

Source§

impl CommandBuilder

Source

pub fn arg<S: Into<String>>(self, name: S, help: S) -> Self

Add a required positional argument.

Source

pub fn arg_opt<S: Into<String>>(self, name: S, help: S) -> Self

Add an optional positional argument.

Source

pub fn args<S: Into<String>>(self, name: S, help: S) -> Self

Add a variadic trailing argument.

Source

pub fn switch<S: Into<String>>( self, long: S, short: Option<char>, help: S, ) -> Self

Add a boolean switch flag.

Source

pub fn value<S: Into<String>>( self, long: S, short: Option<char>, help: S, ) -> Self

Add a value-taking flag.

Source

pub fn example<S: Into<String>>(self, ex: S) -> Self

Attach an example invocation (shown in long help).

Source

pub fn long_about<S: Into<String>>(self, s: S) -> Self

Longer description for the command’s own --help.

Source

pub fn destructive(self) -> Self

Mark this command as destructive (enables guard helpers/semantics).

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.