kurisu

通过自定义 derive 宏进行命令行参数解析

有关 derive(Kurisu) 的完整文档，请参阅 kurisu_derive。

解析、验证和使用显示

库鲁斯将这三个概念分开

use kurisu::*;

#[derive(Debug, Kurisu)]
struct Yargs {
    knots: usize,
}

fn main() {
    let env_vars: Vec<String> = std::env::args().skip(1).collect();

    // Will take the string values from the command line and try to parse them and assign
    // them to the struct's field. If the flag or option is not present then
    // its default type value will be assigned to the struct's field.
    // In this case: usize::default()
    let args = Yargs::from_args(env_vars);

    // Returns an Option<kurisu::arg::Error> or None
    let arg_error = kurisu::validate_usage(&args);

    // If an error is present `print_usage_error` will std::process::exit()
    // with kurisu::ExitCode::USAGE(64) as exit code
    mayuri::print_usage_error(&args, arg_error);

    // Assuming the application was called like so: `mycli --knots 8`
    assert_eq!(args.knots, 8);
}

您可以将其缩短为 kurisu::valid_exit(&args)，它结合了 kurisu::validate_usage(&args) 和 mayuri::print_usage_error(&args)。

库鲁斯试图为结构体设置合理的默认值，如果我们以以下结构体为例

struct Yargs {
    sinking: bool,
    knots: usize,
    pirate_ship_name: String
}

字段 pirate_ship_name 将没有短选项 -p，而只有长选项 --pirate-ship-name。字段名称中的字符 _ 将匹配并显示为 -。由于类型为 bool，字段 sinking 将是一个标志。默认值可以通过注解修改，有关更多信息，请参阅 kurisu_derive。

库鲁斯对参数、标志和选项有具体定义。它们绝对不是官方定义，但这就是在这个库中处理它们的方式。

参数

命令行中的一个单词，例如：mycli myargument。也称为位置参数，其中您可以将特定结构体字段定义为特定参数位置。

它们从不以 - 或 -- 开头。支持的结构体字段类型