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

describes a CLI configuration

See more: https://tauri.app/v1/api/config#cliconfig

Fields

description: Option<String>

Command description which will be shown on the help information.

long_description: Option<String>

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

before_help: 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.

after_help: 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.

args: Option<Vec<CliArg>>

List of arguments for the command

subcommands: Option<HashMap<String, CliConfig>>

List of subcommands of this command

Implementations

impl CliConfig

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

List of arguments for the command

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

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

fn clone(&self) -> CliConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CliConfig

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CliConfig

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CliConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CliConfig

impl StructuralPartialEq for CliConfig