Struct dia_args::ReadOnlyArgs

pub struct ReadOnlyArgs { /* fields omitted */ }

Read-only Args

This struct is simply a read-only wrapper of Args.

Methods

impl ReadOnlyArgs

pub const fn new(args: Args) -> Self

Makes new instance

Methods from Deref<Target = Args>

pub fn cmd(&self) -> Option<&str>

Gets the command

This is simply the first one of args().

pub fn args(&self) -> Option<Vec<&str>>

Gets arguments

If it's some vector, the vector is not empty.

The first one can be used as a command, via cmd().

pub fn options(&self) -> &HashMap<String, Vec<String>>

Gets raw options

Normally you don't need this. Instead, you can use get(), get_vec()...

pub fn sub_args(&self) -> Option<Vec<&str>>

Sub arguments

If it's some vector, the vector is not empty.

pub fn is_empty(&self) -> bool

Checks if there are no arguments/options/sub arguments

pub fn use_stdin(&self) -> bool

Gets flag for using stdin

pub fn get<T>(&self, keys: &[&str]) -> Result<Option<T>> where
    T: FromStr,
    <T as FromStr>::Err: Debug, 

Gets a value

You can provide multiple keys as you want. But the user can only provide one single key of them. This function can be used for short version and long version of your keys.

Examples

use dia_args;

let args = dia_args::parse_strings(["--type", "ogg"].iter())?;
assert_eq!(args.get::<String>(&["-t", "--type"])?.unwrap(), "ogg");

let args = dia_args::parse_strings(["--type", "ogg"].iter())?;
assert!(args.get::<String>(&["-t"])?.is_none());

let args = dia_args::parse_strings(["--type", "ogg", "-t", "some"].iter())?;
args.get::<String>(&["-t", "--type"]).unwrap_err();

pub fn get_vec<T>(&self, keys: &[&str]) -> Result<Option<Vec<T>>> where
    T: FromStr,
    <T as FromStr>::Err: Debug, 

Gets a vector of values

Examples

use dia_args;

let args = dia_args::parse_strings(
    ["--type", "ogg", "-t", "m4v", "--type", "md", "-t", "rs"].iter()
)?;
let mut types = args.get_vec::<String>(&["-t", "--type"])?.unwrap();
types.sort();
assert_eq!(types, &["m4v", "md", "ogg", "rs"]);

Trait Implementations

impl From<Args> for ReadOnlyArgs

fn from(args: Args) -> Self

Performs the conversion.

impl Clone for ReadOnlyArgs

fn clone(&self) -> ReadOnlyArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ReadOnlyArgs

type Target = Args

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Debug for ReadOnlyArgs

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

Formats the value using the given formatter.