Struct celp_sdk::util::celp_app::CelpApp

pub struct CelpApp {
    pub app_name: String,
    /* private fields */
}

CelpApp: Thin wrapper around clap::Command. Allows creating a command line application

Fields

app_name: String

Implementations

impl CelpApp

pub fn new(app_name: &'static str) -> Self

Creates a new CelpApp instantiation with the desired name

Arguments

• app_name - The application name

Example

use celp_sdk::util::celp_app::CelpApp;

let app = CelpApp::new("test");

pub fn ignore_errors(self, yes: bool) -> Self

see clap::Command

pub fn disable_help_flag(self, yes: bool) -> Self

see clap::Command

pub fn allow_missing_positional(self, yes: bool) -> Self

see clap::Command

pub fn arg(self, arg: Arg) -> Self

see clap::Command

pub fn init_logger(self, yes: bool) -> Self

Ensures the logger is initialised (true by default)

Arguments

• yes - Whether to initialise the logging or not

Example

use celp_sdk::util::celp_app::CelpApp;

let matches = CelpApp::new("test")
    .init_logger(false)
    .parse();

pub fn publish_app_info(self, app_info: AppInfo) -> Self

Ensures the app version is published to the broker

Arguments

• app_info - The application info to publish

Examples

use celp_sdk::util::celp_app::{build_app_info, CelpApp};

let app_info = build_app_info("1.0.0").unwrap();

let matches = CelpApp::new("test")
    .publish_app_info(app_info)
    .parse();

pub fn get_matches(self) -> ArgMatches

Parses the command line parameters and propagates the matches

Example

use celp_sdk::util::celp_app::{build_app_info, Arg, CelpApp};

let app_info = build_app_info("1.0.0").unwrap();

let matches = CelpApp::new("test")
    .publish_app_info(app_info)
    .arg(
        Arg::new("test")
        .short('t')
        .long("test")
        .help("Testing an additional variable")
        .required(true)
    )
    .get_matches();

if let Some(t) = matches.get_one::<String>("test") {
    println!("Test argument was set to \"{}\"", t);
}

pub fn parse(self)

Just parse the command line parameters

Example

use celp_sdk::util::celp_app::CelpApp;

let matches = CelpApp::new("test")
    .parse();