Matches

Struct Matches 

Source
pub struct Matches { /* private fields */ }
Expand description

Parse result containing matched arguments

Uses HashMap for O(1) argument lookups. Stores the active subcommand and all parsed argument values.

Implementations§

Source§

impl Matches

Source

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

Source

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

Source

pub fn value_of(&self, name: &str) -> Option<&str>

Source

pub fn values(&self) -> &[String]

Source

pub fn value_as<T>(&self, name: &str) -> Option<T>
where T: FromStr,

Get parsed value as specific type

§Example
let port: u16 = matches.value_as("port").unwrap_or(8080);
Source

pub fn any_present(&self, names: &[&str]) -> bool

Check if any of the given argument names is present

§Example
if matches.any_present(&["verbose", "debug"]) {
    println!("Logging enabled");
}
Source

pub fn all_present(&self, names: &[&str]) -> bool

Check if all of the given argument names are present

Source

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

Get value or return a default

Source

pub fn values_count(&self) -> usize

Get the number of positional arguments

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.