Struct Parameter

pub struct Parameter { /* private fields */ }

Implementations

impl Parameter

pub fn param(name: &str, description: &str) -> Parameter

A parameter that takes a value. Parameters do not have to start with - or –. This is up to the discretion of the user of this library.

Examples found in repository

examples/basic.rs (line 5)

fn main() {
    let mut parser = Parser::new("An example argument parser");
    parser.add_parameter(Parameter::param("--arg0", "Argument 0, type: u32.").default(&5));
    parser.add_parameter(Parameter::param("--arg1", "Argument 1, type: f32.").alias("-a"));
    parser.add_parameter(Parameter::flag("--arg2", "Argument 2, flag").alias("-a2"));

    let args = parser.parse_args();
    for positional in &args.positional {
        println!("Found positional argument: {}", positional);
    }

    let arg0 = args.get::<u32>("--arg0");
    println!("Arg 0 was {}", arg0);

    let arg1 = args.get::<f32>("--arg1");
    println!("Arg 1 was {}", arg1);

    if args.flag("--arg2") {
        println!("Found Arg 2 flag!");
    }
}

pub fn flag(name: &str, description: &str) -> Parameter

Examples found in repository

examples/basic.rs (line 7)

fn main() {
    let mut parser = Parser::new("An example argument parser");
    parser.add_parameter(Parameter::param("--arg0", "Argument 0, type: u32.").default(&5));
    parser.add_parameter(Parameter::param("--arg1", "Argument 1, type: f32.").alias("-a"));
    parser.add_parameter(Parameter::flag("--arg2", "Argument 2, flag").alias("-a2"));

    let args = parser.parse_args();
    for positional in &args.positional {
        println!("Found positional argument: {}", positional);
    }

    let arg0 = args.get::<u32>("--arg0");
    println!("Arg 0 was {}", arg0);

    let arg1 = args.get::<f32>("--arg1");
    println!("Arg 1 was {}", arg1);

    if args.flag("--arg2") {
        println!("Found Arg 2 flag!");
    }
}

pub fn alias(self, alias: &str) -> Parameter

Examples found in repository

examples/basic.rs (line 6)

fn main() {
    let mut parser = Parser::new("An example argument parser");
    parser.add_parameter(Parameter::param("--arg0", "Argument 0, type: u32.").default(&5));
    parser.add_parameter(Parameter::param("--arg1", "Argument 1, type: f32.").alias("-a"));
    parser.add_parameter(Parameter::flag("--arg2", "Argument 2, flag").alias("-a2"));

    let args = parser.parse_args();
    for positional in &args.positional {
        println!("Found positional argument: {}", positional);
    }

    let arg0 = args.get::<u32>("--arg0");
    println!("Arg 0 was {}", arg0);

    let arg1 = args.get::<f32>("--arg1");
    println!("Arg 1 was {}", arg1);

    if args.flag("--arg2") {
        println!("Found Arg 2 flag!");
    }
}

pub fn default<T>(self, default: &T) -> Parameter

where T: ToString,

Examples found in repository

examples/basic.rs (line 5)

fn main() {
    let mut parser = Parser::new("An example argument parser");
    parser.add_parameter(Parameter::param("--arg0", "Argument 0, type: u32.").default(&5));
    parser.add_parameter(Parameter::param("--arg1", "Argument 1, type: f32.").alias("-a"));
    parser.add_parameter(Parameter::flag("--arg2", "Argument 2, flag").alias("-a2"));

    let args = parser.parse_args();
    for positional in &args.positional {
        println!("Found positional argument: {}", positional);
    }

    let arg0 = args.get::<u32>("--arg0");
    println!("Arg 0 was {}", arg0);

    let arg1 = args.get::<f32>("--arg1");
    println!("Arg 1 was {}", arg1);

    if args.flag("--arg2") {
        println!("Found Arg 2 flag!");
    }
}

Trait Implementations

impl Debug for Parameter

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

Formats the value using the given formatter.