Struct Parser 

#[non_exhaustive]
pub struct Parser<'a> { /* private fields */ }

Builder for parsing command-line arguments with custom options.

Use this when you need to customize parsing behavior, such as providing a custom environment variable map instead of using the process environment.

Example

use std::collections::HashMap;
use usage::Spec;
use usage::parse::Parser;

let spec: Spec = r#"flag "--name <name>" env="NAME""#.parse().unwrap();
let env: HashMap<String, String> = [("NAME".into(), "john".into())].into();

let result = Parser::new(&spec)
    .with_env(env)
    .parse(&["cmd".into()])
    .unwrap();

Implementations

impl<'a> Parser<'a>

pub fn new(spec: &'a Spec) -> Self

Create a new parser for the given spec.

pub fn with_env(self, env: HashMap<String, String>) -> Self

Use a custom environment variable map instead of the process environment.

This is useful when parsing for tasks in a monorepo where the env vars come from a child config file rather than the current process environment.

pub fn parse(self, input: &[String]) -> Result<ParseOutput, Error>

Parse the input arguments.

Returns the parsed arguments and flags, with defaults and env vars applied.