Skip to main content

struct.CliConfig

pub struct CliConfig {
    pub description: Option<String>,
    pub long_description: Option<String>,
    pub before_help: Option<String>,
    pub after_help: Option<String>,
    pub args: Option<Vec<CliArg, Global>>,
    pub subcommands: Option<HashMap<String, CliConfig, RandomState>>,
}

The CLI root command definition.

Fields#

description: Option<String>``long_description: Option<String>``before_help: Option<String>``after_help: Option<String>``args: Option<Vec<CliArg, Global>>``subcommands: Option<HashMap<String, CliConfig, RandomState>>

Implementations#

impl CliConfig#

pub fn args(&self) -> Option<&Vec<CliArg, Global>>#

List of args for the command

pub fn subcommands(&self) -> Option<&HashMap<String, CliConfig, RandomState>>#

List of subcommands of this command

pub fn description(&self) -> Option<&String>#

Command description which will be shown on the help information.

pub fn long_description(&self) -> Option<&String>#

Command long description which will be shown on the help information.

pub fn before_help(&self) -> Option<&String>#

Adds additional help information to be displayed in addition to auto-generated help. This information is displayed before the auto-generated help information. This is often used for header information.

pub fn after_help(&self) -> Option<&String>#

Adds additional help information to be displayed in addition to auto-generated help. This information is displayed after the auto-generated help information. This is often used to describe how to use the arguments, or caveats to be noted.

Trait Implementations#

impl Clone for CliConfig#

pub fn clone(&self) -> CliConfig#

Returns a copy of the value. Read more

pub fn clone_from(&mut self, source: &Self)1.0.0#

Performs copy-assignment from source. Read more

impl Debug for CliConfig#

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>#

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for CliConfig#

pub fn deserialize<__D>( __deserializer: __D ) -> Result<CliConfig, <__D as Deserializer<'de>>::Error> where __D: Deserializer<'de>,#

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<CliConfig> for CliConfig#

pub fn eq(&self, other: &CliConfig) -> bool#

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

pub fn ne(&self, other: &CliConfig) -> bool#

This method tests for !=.

impl StructuralPartialEq for CliConfig#

impl ToTokens for CliConfig#

pub fn to_tokens(&self, tokens: &mut TokenStream)#

Write self to the given TokenStream. Read more

pub fn to_token_stream(&self) -> TokenStream#

Convert self directly into a TokenStream object. Read more

pub fn into_token_stream(self) -> TokenStream#

Convert self directly into a TokenStream object. Read more

Auto Trait Implementations#

impl RefUnwindSafe for CliConfig#

impl Send for CliConfig#

impl Sync for CliConfig#

impl Unpin for CliConfig#

impl UnwindSafe for CliConfig#

Blanket Implementations#

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

pub fn type_id(&self) -> TypeId#

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T#

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mutT#

Mutably borrows from an owned value. Read more

impl<'de, D, P> CommandArg<'de, P> for D where P: Params, D: Deserialize<'de>,#

pub fn from_command(CommandItem<'de, P>) -> Result<D, InvokeError>#

Derives an instance of Self from the CommandItem. Read more

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,#

impl<T> From<T> for T#

pub fn from(t: T) -> T#

Performs the conversion.

impl<T> Instrument for T#

pub fn instrument(self, span: Span) -> Instrumented<Self>#

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

pub fn in_current_span(self) -> Instrumented<Self>#

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

pub fn into(self) -> U#

Performs the conversion.

impl<T> Pointable for T#

pub const ALIGN: usize#

The alignment of pointer.

type Init = T#

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize#

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'aT#

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mutT#

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)#

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T where T: Clone,#

type Owned = T#

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T#

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mutT)#

๐Ÿ”ฌ This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible#

The type returned in the event of a conversion error.

pub 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.

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

Performs the conversion.

impl<V, T> VZip<V> for T where V: MultiLane<T>,#

pub fn vzip(self) -> V#