Rust中docopt示例运行命令及参数解析异常问题

V1 版本问题修正 #

问题根源 #

1. 多命令/模式未做区分：USAGE定义了cp的两种子模式和tk命令，但Args结构体将所有位置参数设为必填String，导致互斥参数无法正确映射（比如第一个cp模式无<dir>，但结构体强制要求arg_dir，最终出现错误赋值）。
2. 可变参数类型错误：cp [-a] <source>... <dir>中的<source>...是多值参数，对应字段应为Vec<String>而非单个String。
3. 未利用枚举区分命令模式：Docopt对互斥的命令模式，推荐用枚举结构体来分别映射，避免字段冲突。

修正后代码 #

#[macro_use]
extern crate serde_derive;

use docopt::Docopt;

const USAGE: &'static str = "
Usage: cp [-a] <source> <dest>
       cp [-a] <source>... <dir>
       tk [-a] <source> <dest>

Options:
    -a, --archive  Copy everything.
";

#[derive(Debug, Deserialize)]
enum Command {
    // 对应 cp 单源文件模式
    CpSingle {
        flag_archive: bool,
        arg_source: String,
        arg_dest: String,
    },
    // 对应 cp 多源文件模式
    CpMultiple {
        flag_archive: bool,
        arg_source: Vec<String>,
        arg_dir: String,
    },
    // 对应 tk 命令模式
    Tk {
        flag_archive: bool,
        arg_source: String,
        arg_dest: String,
    },
}

fn main() {
    let args: Command = Docopt::new(USAGE)
        .and_then(|d| d.deserialize())
        .unwrap_or_else(|e| e.exit());

    println!("{:?}", args);
}

执行cargo run -- cp -a file_a dest_a，输出符合预期：

CpSingle { flag_archive: true, arg_source: "file_a", arg_dest: "dest_a" }

V2 版本问题修正 #

问题根源 #

1. 选项参数标记错误：USAGE中--arch ARCHIVE需用尖括号<ARCHIVE>标记参数占位符，否则Docopt无法识别这是带值选项。
2. 字段命名规则错误：带值选项对应的结构体字段前缀应为option_（flag_仅用于布尔开关类无值选项）。
3. 缩写选项未同步到USAGE：Options中定义了-a作为--arch的缩写，但USAGE里未体现，导致无法通过缩写传参。

修正后代码 #

#[macro_use]
extern crate serde_derive;

use docopt::Docopt;

const USAGE: &'static str = "
Usage: terminal --arch <ARCHIVE> --dest <DESTIN>
       terminal -a <ARCHIVE> -d <DESTIN>

Options:
    --arch <ARCHIVE>, -a <ARCHIVE>  要复制的文件路径
    --dest <DESTIN>, -d <DESTIN>    目标路径
";

#[derive(Debug, Deserialize)]
struct Args {
    option_arch: String,
    option_dest: String,
}

fn main() {
    let args: Args = Docopt::new(USAGE)
        .and_then(|d| d.deserialize())
        .unwrap_or_else(|e| e.exit());

    println!("{:?}", args);
}

执行cargo run -- terminal --arch muun --dest hello，输出符合预期：

Args { option_arch: "muun", option_dest: "hello" }

Docopt 核心规则补充 #

• 位置参数：单个用<NAME>，对应arg_name: String；多值加...，对应arg_name: Vec<String>。
• 布尔开关：-x/--xxx，对应flag_name: bool。
• 带值选项：--xxx <VALUE>/-x <VALUE>，对应option_name: String（可选则用Option<String>）。
• 多命令模式：必须用枚举结构体区分，避免不同模式的字段冲突。

内容的提问来源于stack exchange，提问作者DustInTheSilence