Struct Args

Source
pub struct Args {
    pub positional: Vec<String>,
    /* private fields */
}

Fields§

§positional: Vec<String>

Implementations§

Source§

impl Args

Source

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

Examples found in repository?
examples/basic.rs (line 20)
3fn main() {
4    let mut parser = Parser::new("An example argument parser");
5    parser.add_parameter(Parameter::param("--arg0", "Argument 0, type: u32.").default(&5));
6    parser.add_parameter(Parameter::param("--arg1", "Argument 1, type: f32.").alias("-a"));
7    parser.add_parameter(Parameter::flag("--arg2", "Argument 2, flag").alias("-a2"));
8
9    let args = parser.parse_args();
10    for positional in &args.positional {
11        println!("Found positional argument: {}", positional);
12    }
13
14    let arg0 = args.get::<u32>("--arg0");
15    println!("Arg 0 was {}", arg0);
16
17    let arg1 = args.get::<f32>("--arg1");
18    println!("Arg 1 was {}", arg1);
19
20    if args.flag("--arg2") {
21        println!("Found Arg 2 flag!");
22    }
23}
Source

pub fn get<T>(&self, param: &str) -> T
where T: FromStr, <T as FromStr>::Err: Debug,

Examples found in repository?
examples/basic.rs (line 14)
3fn main() {
4    let mut parser = Parser::new("An example argument parser");
5    parser.add_parameter(Parameter::param("--arg0", "Argument 0, type: u32.").default(&5));
6    parser.add_parameter(Parameter::param("--arg1", "Argument 1, type: f32.").alias("-a"));
7    parser.add_parameter(Parameter::flag("--arg2", "Argument 2, flag").alias("-a2"));
8
9    let args = parser.parse_args();
10    for positional in &args.positional {
11        println!("Found positional argument: {}", positional);
12    }
13
14    let arg0 = args.get::<u32>("--arg0");
15    println!("Arg 0 was {}", arg0);
16
17    let arg1 = args.get::<f32>("--arg1");
18    println!("Arg 1 was {}", arg1);
19
20    if args.flag("--arg2") {
21        println!("Found Arg 2 flag!");
22    }
23}

Trait Implementations§

Source§

impl Clone for Args

Source§

fn clone(&self) -> Args

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Args

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Args

§

impl RefUnwindSafe for Args

§

impl Send for Args

§

impl Sync for Args

§

impl Unpin for Args

§

impl UnwindSafe for Args

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.