Struct tauri_utils::config::CliConfig
source · 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>>,
}
Expand description
describes a CLI configuration
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
sourceimpl CliConfig
impl CliConfig
sourcepub fn subcommands(&self) -> Option<&HashMap<String, CliConfig>>
pub fn subcommands(&self) -> Option<&HashMap<String, CliConfig>>
List of subcommands of this command
sourcepub fn description(&self) -> Option<&String>
pub fn description(&self) -> Option<&String>
Command description which will be shown on the help information.
sourcepub fn long_description(&self) -> Option<&String>
pub fn long_description(&self) -> Option<&String>
Command long description which will be shown on the help information.
sourcepub fn before_help(&self) -> Option<&String>
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.
sourcepub fn after_help(&self) -> Option<&String>
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.