clap_derive

通过定义结构体来解析命令行参数。它将structopt和clap结合成一个单一体验。此crate由clap使用，不建议直接由消费者使用。

文档

在Docs.rs上找到。您还可以查看示例和变更日志。

示例

将clap添加到您的Cargo.toml的依赖中

[dependencies]
nameless-clap = "3"

然后在您的rust文件中

use std::path::PathBuf;
use nameless_clap::Clap;

/// A basic example
#[derive(Clap, Debug)]
#[clap(name = "basic")]
struct Opt {
    // A flag, true if used in the command line. Note doc comment will
    // be used for the help message of the flag. The name of the
    // argument will be, by default, based on the name of the field.
    /// Activate debug mode
    #[clap(short, long)]
    debug: bool,

    // The number of occurrences of the `v/verbose` flag
    /// Verbose mode (-v, -vv, -vvv, etc.)
    #[clap(short, long, parse(from_occurrences))]
    verbose: u8,

    /// Set speed
    #[clap(short, long, default_value = "42")]
    speed: f64,

    /// Output file
    #[clap(short, long, value_hint = ValueHint::FilePath)]
    output: PathBuf,

    // the long option will be translated by default to kebab case,
    // i.e. `--nb-cars`.
    /// Number of cars
    #[clap(short = "c", long)]
    nb_cars: Option<i32>,

    /// admin_level to consider
    #[clap(short, long)]
    level: Vec<String>,

    /// Files to process
    #[clap(name = "FILE", value_hint = ValueHint::AnyPath)]
    files: Vec<PathBuf>,
}

fn main() {
    let opt = Opt::parse();
    println!("{:#?}", opt);
}

使用此示例

$ ./basic
error: The following required arguments were not provided:
    --output <output>

USAGE:
    basic --output <output> --speed <speed>

For more information try --help
$ ./basic --help
basic 0.3.0
Guillaume Pinot <[email protected]>, others
A basic example

USAGE:
    basic [FLAGS] [OPTIONS] --output <output> [--] [file]...

ARGS:
    <FILE>...    Files to process

FLAGS:
    -d, --debug      Activate debug mode
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v, --verbose    Verbose mode (-v, -vv, -vvv, etc.)

OPTIONS:
    -l, --level <level>...     admin_level to consider
    -c, --nb-cars <nb-cars>    Number of cars
    -o, --output <output>      Output file
    -s, --speed <speed>        Set speed [default: 42]

ARGS:
    <file>...    Files to process
$ ./basic -o foo.txt
Opt {
    debug: false,
    verbose: 0,
    speed: 42.0,
    output: "foo.txt",
    nb_cars: None,
    level: [],
    files: [],
}
$ ./basic -o foo.txt -dvvvs 1337 -l alice -l bob --nb-cars 4 bar.txt baz.txt
Opt {
    debug: true,
    verbose: 3,
    speed: 1337.0,
    output: "foo.txt",
    nb_cars: Some(
        4,
    ),
    level: [
        "alice",
        "bob",
    ],
    files: [
        "bar.txt",
        "baz.txt",
    ],
}

clap_derive rustc版本策略

• 最小rustc版本修改必须在变更日志和travis配置中指定。
• 如果新的版本是clap_derive的依赖项的最新版本所必需的，则贡献者可以在没有任何理由的情况下增加最小rustc版本（使用cargo update不会在clap_derive上失败）。
• 如果库的用户体验得到改善，则贡献者可以增加最小rustc版本。

为什么

我（@TeXitoi）长时间使用过 docopt（在 Rust 1.0 之前）。我真的很喜欢它提供的解析后的参数结构：不需要将 String 转换为 f64，不需要无用的 unwrap。但另一方面，我不喜欢手动编写用法字符串。这就像是回到了 WYSIWYG 编辑器的黄金时代。字段命名也有些人为。

今天，Rust 中读取命令行参数的新标准是 clap。这个库功能非常强大！但我认为有一个缺点：即使你可以验证参数并表达参数是必需的，你仍然需要将类似于字符串向量哈希表的东西转换为你应用程序有用的东西。

现在，已经有了稳定的自定义 derive。因此，我可以为 clap 添加我缺失的自动转换。以下是结果。

许可证

根据您的要求，许可方式如下

• Apache 许可证 2.0 版（LICENSE-APACHE 或 https://www.apache.org/licenses/LICENSE-2.0）
• MIT 许可证（LICENSE-MIT 或 https://opensource.org/licenses/MIT）

任选其一。

贡献

除非您明确表示，否则根据 Apache-2.0 许可证定义，您提交的任何旨在包含在作品中的贡献都将根据上述方式双重许可，不附加任何额外条款或条件。