Struct args::ArgumentParser

pub struct ArgumentParser { /* private fields */ }

Implementations

impl ArgumentParser

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

Constructor for the argument parser.

pub fn name(&self) -> &str

The name of the parser.

pub fn argument_count(&self) -> usize

The number of arguments currently registered with the parser.

pub fn with_author(self, author: &str)

pub fn with_description(self, description: &str)

pub fn with_argument(self, argument: Argument) -> Self

pub fn compile(self, args: &[String]) -> Vec<ParsedArgument>

Compiles a slice of Strings into an array of Parsed Arguments. This will move the parser into this function and return back the parsed arguments if everything succeeds. This function assumes that the first item within args is the name of the executable being run. (Which is the standard for arguments passed in from std::env::args()). The ordering of the arguments returned is always the same as order they’re registered in with the parser.