Struct simple_arguments::Arguments

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

the main struct which is responsible for managing all argument parsing logic

Methods

impl<'a> Arguments<'a>

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

initialises a new Arguments struct. You can give it an optional executable name which will be used to create the usage String.

pub fn add<T, S>(&mut self, filler: T, name: S, description: &str) where
    T: Filler + 'a,
    S: ToString, 

adds a new argument to the struct. filler must implement filler (all &mut T where T: FromStr implement Filler)

pub fn parse<S: AsRef<str>>(
    &mut self,
    arguments: &[S]
) -> Result<Vec<String>, String>

fills every argument with the given arguments and returns a vector of all the arguments that weren't taken by any flag. If it fails, returns a string describing a parsing error or a lack of remaining arguments

pub fn usage(&self) -> String

generates a usage string

pub fn add_bool<S: ToString>(
    &mut self,
    b: &'a mut bool,
    name: S,
    description: &str
)

since the default implementation of Filller for &mut bool would require the user tu write ./program --boolean-flag true instead of just ./program --boolean-flag, this functions adds a flag that, when given, will autmatically set the given variable to true