Struct Command

pub struct Command<'a> { /* private fields */ }

Command represents a command parsed from the command-line Use CliBuilder to build a parsed Command

Example

use kern::CliBuilder;
use std::env;

let args: Vec<String> = env::args().collect();
let command = CliBuilder::new().options(&["option"]).build(&args);
assert_eq!(command.command().contains("rustdoctest"), true);

Implementations

impl<'a> Command<'a>

pub fn command(&self) -> &'a str

Get command name

pub fn parameters(&self) -> &HashMap<&'a str, &'a str>

Get all parameters

pub fn arguments(&self) -> &Vec<&'a str>

Get all arguments

pub fn parameter<T: FromStr>(&self, name: &str, default: T) -> T

Get specific parameter or default

pub fn param(&self, name: &str, default: &'a str) -> &str

Get specific parameter or default as &str

pub fn options(&self) -> &Vec<&str>

Get all options

pub fn option(&self, name: &str) -> bool

Check if option provided

pub fn argument<T: FromStr>(&self, index: usize, default: T) -> T

Get argument at specific index or default

pub fn arg(&self, index: usize, default: &'a str) -> &str

Get argument at specific index or default as &str

pub fn without_options(raw: &'a [String]) -> Self

👎Deprecated

Create a new Command from raw command line arguments without options

pub fn from(raw: &'a [String], options: &'a [&str]) -> Self

👎Deprecated

Create a new Command from raw command line arguments Provide the options list as &&str

Trait Implementations

impl<'a> Clone for Command<'a>

fn clone(&self) -> Command<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Command<'a>

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

Formats the value using the given formatter.