StructOpt

通过定义结构体来解析命令行参数。它结合了 clap 和自定义 derive。

维护

由于 clap v3 已经发布，并且 structopt 的功能已经集成（几乎原样），structopt 现在处于维护模式：不会添加新功能。

将修复错误，并接受文档改进。

请参阅 structopt -> clap 迁移指南

文档

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

示例

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

[dependencies]
structopt = "0.3"

然后在您的 rust 文件中

use std::path::PathBuf;
use structopt::StructOpt;

/// A basic example
#[derive(StructOpt, Debug)]
#[structopt(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
    #[structopt(short, long)]
    debug: bool,

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

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

    /// Output file
    #[structopt(short, long, parse(from_os_str))]
    output: PathBuf,

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

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

    /// Files to process
    #[structopt(name = "FILE", parse(from_os_str))]
    files: Vec<PathBuf>,
}

fn main() {
    let opt = Opt::from_args();
    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]...

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",
    ],
}

StructOpt rustc 版本策略

• 必须在上面的 变更日志 和 travis 配置 中指定最小 rustc 版本修改。
• 如果新的版本需要 StructOpt 依赖的最新版本，并且 cargo update 不会在 StructOpt 上失败，则贡献者可以在没有任何理由的情况下增加最小 rustc 版本。
• 如果改进了库的用户体验，则贡献者可以增加最小 rustc 版本。

许可

许可协议为

• Apache License，版本 2.0 (LICENSE-APACHE 或 https://www.apache.org/licenses/LICENSE-2.0)
• 麻省理工学院许可证（《LICENSE-MIT》或https://opensource.org/licenses/MIT）

由你自行选择。

贡献

除非你明确声明，否则根据Apache-2.0许可证定义，你提交给工作以供包含的任何贡献都将按上述方式双授权，不附加任何额外条款或条件。

lib.rs:

此crate是为StructOpt自定义的 derive。它不应直接使用。有关使用#[derive(StructOpt)]的说明，请参阅structopt 文档。