Struct Cli

pub struct Cli<T>
where
    T: Cluster,
{ /* private fields */ }

CLI parser

Implementations

impl<T> Cli<T>

where T: Cluster,

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

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

pub async fn execute_with( &self, yozefu_config: YozefuConfig, ) -> Result<(), TuiError>

Executes the CLI with a specified kafka config client

Examples found in repository

examples/my_cli.rs (line 62)

    pub async fn execute(&self) -> Result<(), TuiError> {
        // To pass your configuration, create a `YozefuConfig`.
        let yozefu_config = YozefuConfig::new(self.kafka_client_config());
        // And pass it to the `yozefu_command::Cli`
        self.command.execute_with(yozefu_config).await
    }

pub fn cluster(&self) -> Option<T>

This function returns Some(T) when the user starts the TUI. Otherwise, for subcommands commands that such config or new-filter, it returns None.

Examples found in repository

examples/my_cli.rs (line 32)

    pub fn kafka_client_config(&self) -> ClusterConfig {
        let mut config = ClientConfig::new();
        config.set_log_level(rdkafka::config::RDKafkaLogLevel::Emerg);
        if let Some(cluster) = self.command.cluster() {
            match cluster {
                Cluster::Localhost => {
                    config.set("bootstrap.servers", "kafka.localhost.acme:9092".to_string())
                }
                Cluster::Test => {
                    config.set("bootstrap.servers", "kafka.test.acme:9092".to_string())
                }
                Cluster::Development => config.set(
                    "bootstrap.servers",
                    "kafka.development.acme:9092".to_string(),
                ),
                Cluster::Production => config.set(
                    "bootstrap.servers",
                    "kafka.production.acme:9092".to_string(),
                ),
            };
        }

        ClusterConfig {
            url_template: None,
            schema_registry: None,
            kafka: IndexMap::from_iter(config.config_map().clone()),
        }
    }

pub fn is_main_command(&self) -> bool

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

Changes the default logs file path

Trait Implementations

impl<T> Args for Cli<T>

where T: Cluster,

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: Cluster,

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: Cluster,

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: Cluster,

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.