Struct easy_flag::FlagSet

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

Represents a set of defined flags.

Methods

impl<'a> FlagSet<'a>

pub fn new(name: &str) -> Self

Constructs a new FlagSet instance. The name will be added to the usage information.

Examples

 let set = FlagSet::new("my set")

pub fn add(self, name: &'a str, var: &'a mut dyn Any, help: &'a str) -> Self

Adds a new flag to the FlagSet

The function itself determines the type of flag. The standard types are supported: bool, f32, f64, i8, i16, i32, i128, isize, u8, u16, u32, u128, usize, String.

WARNING: Unsupported type will cause panic.

Examples

 let mut f = String::from("default value");
 FlagSet::new("my set").add("-f, --flag", &mut f, "flag `example`")

pub fn parse(&mut self, args: &[String]) -> Result<(), String>

Parsing args.

Examples

 let mut f = String::from("default value");
 let args: Vec<String> = std::env::args().collect();
 FlagSet::new(&args[0])
                .add("-f, --flag", &mut f, "flag `example`")
                .parse(&args[1..])
                .unwrap()

pub fn name(&self) -> &str

Gets flag set name.

pub fn usage(&self) -> String

Formats a usage message with set name.

pub fn defaults(&self) -> String

Formats a flag list message.

Trait Implementations

impl<'a> Debug for FlagSet<'a>

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

Formats the value using the given formatter.