Struct Cli

pub struct Cli<T>
where
    T: Display + Debug + Clone + Sync + Send + 'static + FromStr,
    <T as FromStr>::Err: Display,
{
    pub subcommands: Option<UtilityCommands>,
    pub default_command: MainCommand<T>,
    /* private fields */
}

CLI parser

Fields

subcommands: Option<UtilityCommands>

default_command: MainCommand<T>

Implementations

impl<T> Cli<T>

where T: Display + Debug + Clone + Sync + Send + 'static + FromStr, <T as FromStr>::Err: Display,

pub async fn execute(&self) -> Result<(), TuiError>

Executes the CLI. The kafka config client will be loaded from the default config file.

pub fn logs_file(&mut self, logs: PathBuf) -> &mut Self

Changes the default logs file path

pub async fn execute_with( &self, config_client: ClientConfig, ) -> Result<(), TuiError>

Executes the CLI with a specified kafka config client

Examples found in repository

examples/my_cli.rs (line 45)

    pub async fn execute(&self) -> Result<(), TuiError> {
        self.command.execute_with(self.kafka_client_config()).await
    }

Trait Implementations

impl<T> Args for Cli<T>

where T: Display + Debug + Clone + Sync + Send + 'static + FromStr, <T as FromStr>::Err: Display,

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl<T> CommandFactory for Cli<T>

where T: Display + Debug + Clone + Sync + Send + 'static + FromStr, <T as FromStr>::Err: Display,

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl<T> FromArgMatches for Cli<T>

where T: Display + Debug + Clone + Sync + Send + 'static + FromStr, <T as FromStr>::Err: Display,

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl<T> Parser for Cli<T>

where T: Display + Debug + Clone + Sync + Send + 'static + FromStr, <T as FromStr>::Err: Display,

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.