Struct clipars::Command

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

Command represents an command parsed from the command-line

Example

extern crate clipars;

use clipars::Command;
use std::env;

let env_args = env::args().collect::<Vec<String>>();
let command = Command::from(
    &env_args.iter().map(|s| &**s).collect::<Vec<&str>>()[..],
    &["option1", "option2"],
);

Methods

impl<'a> Command<'a>

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

Get command name

pub fn get_parameters(&self) -> &BTreeMap<&'a str, &'a str>

Get all parameters

pub fn get_parameter(&self, name: &'a str) -> Option<&&'a str>

Get specific parameter

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

Get all options

pub fn is_option(&self, name: &'a str) -> bool

Check if option provided

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

Get all arguments

pub fn get_argument(&self, index: usize) -> Option<&&'a str>

Get argument at specific index

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

Create a new Command from raw command line arguments without options Provide the arguments list as Vec

extern crate clipars;

use clipars::Command;
use std::env;

let command = Command::without_options(&["command --param=value"]);

pub fn without_command(raw: &[&'a str], filter_options: &[&str]) -> Self

Create a new Command from raw command line arguments without a command name Provide the arguments list as Vec

The command [./command --param1=value1 more args] without the command name is [--param1=value1 more args]

extern crate clipars;

use clipars::Command;
use std::env;

let command = Command::without_command(&["--param=value"], &["option"]);

pub fn without_command_and_options(raw: &[&'a str]) -> Self

Create a new Command from raw command line arguments without a command name and without options Provide the arguments list as Vec

The command [./command --param1=value1 more args] without the command name is [--param1=value1 more args]

extern crate clipars;

use clipars::Command;
use std::env;

let command = Command::without_command_and_options(&["--param=value"]);

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

Create a new Command from raw command line arguments Provide the arguments list as Vec

extern crate clipars;

use clipars::Command;
use std::env;

let command = Command::from(&["command --param=value"], &["option"]);

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.