Lexopt

Lexopt 是一个 Rust 的参数解析器。它试图拥有最简单可能的设计同时保持正确性。它的简单性使得使用起来略显繁琐。

Lexopt 是

• 小巧：单一文件，无依赖，无宏。易于审计或定制。
• 正确：支持标准约定并避免歧义。经过测试和模糊测试。
• 严谨：参数以 OsString 的形式返回，迫使您显式地进行转换。这使得您能够处理错误编码的文件名。
• 命令式：选项按找到的顺序返回，事先没有声明任何内容。
• 简约：只提供基本功能。
• 不友好：没有帮助生成，错误消息通常缺乏上下文。

示例

struct Args {
    thing: String,
    number: u32,
    shout: bool,
}

fn parse_args() -> Result<Args, lexopt::Error> {
    use lexopt::prelude::*;

    let mut thing = None;
    let mut number = 1;
    let mut shout = false;
    let mut parser = lexopt::Parser::from_env();
    while let Some(arg) = parser.next()? {
        match arg {
            Short('n') | Long("number") => {
                number = parser.value()?.parse()?;
            }
            Long("shout") => {
                shout = true;
            }
            Value(val) if thing.is_none() => {
                thing = Some(val.string()?);
            }
            Long("help") => {
                println!("Usage: hello [-n|--number=NUM] [--shout] THING");
                std::process::exit(0);
            }
            _ => return Err(arg.unexpected()),
        }
    }

    Ok(Args {
        thing: thing.ok_or("missing argument THING")?,
        number,
        shout,
    })
}

fn main() -> Result<(), lexopt::Error> {
    let args = parse_args()?;
    let mut message = format!("Hello {}", args.thing);
    if args.shout {
        message = message.to_uppercase();
    }
    for _ in 0..args.number {
        println!("{}", message);
    }
    Ok(())
}

让我们来看看这个

• 我们使用 Parser::from_env() 开始解析。
• 我们通过循环调用 parser.next() 来获取所有参数，直到它们耗尽。
• 我们对参数进行匹配。 Short 和 Long 指示一个选项。
• 要获取属于选项的值（如 10 在 -n 10 中），我们调用 parser.value()。
  • 这返回一个标准的 OsString。
  • 为了方便，使用 use lexopt::prelude::* 会添加一个 .parse() 方法，类似于 str::parse。
  • 调用 parser.value() 是告诉 Parser -n 需要一个值的。
• Value 表示一个独立的参数。
  • if thing.is_none() 是处理位置参数的有用模式。如果我们已经找到了 thing，我们将其传递给另一个情况。
  • 它还包含一个 OsString。
    • .string() 方法将其解码为普通的 String。
• 如果我们不知道如何处理一个参数，我们使用 return Err(arg.unexpected()) 将其转换为错误信息。
• 字符串可以被提升为错误，用于自定义错误信息。