Struct Parser 

pub struct Parser { /* private fields */ }

The main parser object used to define arguments and run the parser.

Implementations

impl Parser

pub fn new() -> Self

Creates a new, empty parser.

pub fn add_flag(&mut self, long_name: &str) -> ArgumentBuilder<'_>

Defines a flag argument (e.g., –verbose, -v).

Returns an ArgumentBuilder to add optional configurations.

pub fn add_option(&mut self, long_name: &str) -> ArgumentBuilder<'_>

Defines an option argument that takes a value (e.g., –output ).

Returns an ArgumentBuilder to add optional configurations.

pub fn add_positional(&mut self, long_name: &str) -> ArgumentBuilder<'_>

Defines a positional argument (e.g., ).

Returns an ArgumentBuilder to add optional configurations.

pub fn generate_help(&self) -> String

Generates a formatted help message string based on the defined arguments.

pub fn parse<T: Iterator<Item = String>>( &self, args: T, ) -> Result<ParsedArgs, ArgParseError>

Parses a given iterator of string arguments.

This is the main entry point for the parser.

Errors

Returns an ArgParseError variant if parsing fails, if --help is requested, or if a required argument is missing.