Struct tauri_utils::config::CliConfig[][src]

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>>,
    pub subcommands: Option<HashMap<String, CliConfig>>,
}

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>>subcommands: Option<HashMap<String, CliConfig>>

Implementations

impl CliConfig[src]

pub fn args(&self) -> Option<&Vec<CliArg>>[src]

List of args for the command

pub fn subcommands(&self) -> Option<&HashMap<String, CliConfig>>[src]

List of subcommands of this command

pub fn description(&self) -> Option<&String>[src]

Command description which will be shown on the help information.

pub fn long_description(&self) -> Option<&String>[src]

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

pub fn before_help(&self) -> Option<&String>[src]

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>[src]

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[src]

impl Debug for CliConfig[src]

impl<'de> Deserialize<'de> for CliConfig[src]

impl PartialEq<CliConfig> for CliConfig[src]

impl StructuralPartialEq for CliConfig[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.