如何基于标志使用clap实现类rsync程序的内部操作（非子命令）

我开发了一个类rsync的Rust程序，主命令行格式为program src dest。程序需要通过SSH在远端调用自身完成文件读写，这是内部实现细节，不想暴露为显式子命令，避免src参数被误解析。

需求如下：

• program --read file：将指定文件内容输出到stdout
• program --write file：将stdin内容写入指定文件
• program ./local user@remote:remote/file：本地文件内容通过SSH传给远端执行的program --write remote/file
• program user@remote:remote/file ./local：远端program --read file的输出写入本地文件

尝试用clap的derive API和ArgGroup实现，但当前代码存在两个问题：

1. 错误提示混乱，比如执行program --read from时，提示会包含<FROM>和<TO>参数，不符合预期
2. 无法实现--read/--write搭配单个文件参数的功能

当前代码：

use std::ffi::OsString;
use clap::{Args, Parser};

#[derive(Parser, Debug)]
struct RsyncExample {
    #[command(flatten)]
    inner_op: ImplOperation,

    #[command(flatten)]
    transfer: Option<FileTransfer>,
}

#[derive(Args, Clone, Debug)]
#[group(required = false, multiple = false, conflicts_with = "FileTransfer")]
struct ImplOperation {
    #[arg(long)]
    read: bool,
    #[arg(long)]
    write: bool,
}

#[derive(Args, Clone, Debug)]
struct FileTransfer {
    from: OsString,
    to: OsString,
}

fn main() {
    let cli = RsyncExample::parse();
    println!("{cli:?}");
}

执行错误命令的输出：

$ cargo run -- --read from
error: the argument '--read' cannot be used with:
  <FROM>
  <TO>

Usage: blktrans --read <FROM> <TO>

For more information, try '--help'.

不想通过创建程序链接、基于argv[0]分发的方式解决，寻求其他方案。

要实现需求，需要明确区分两种互斥的运行模式：内部操作模式（--read或--write加单个文件参数）和文件传输模式（两个位置参数）。通过调整ArgGroup配置，并为内部操作的flags关联对应文件参数，可解决问题。

修改后的代码如下：

use std::ffi::OsString;
use clap::{Parser};

#[derive(Parser, Debug)]
#[command(arg_required_else_help = true)]
struct RsyncExample {
    #[command(group = "mode", required = true)]
    /// 内部操作：读取文件到stdout
    #[arg(long, requires = "read_path", conflicts_with_all = ["write", "from", "to"])]
    read: bool,

    #[command(group = "mode")]
    /// 内部操作：从stdin写入文件
    #[arg(long, requires = "write_path", conflicts_with_all = ["read", "from", "to"])]
    write: bool,

    /// 配合--read使用的目标文件路径
    #[arg(id = "read_path", required_if("read", "true"))]
    read_path: Option<OsString>,

    /// 配合--write使用的目标文件路径
    #[arg(id = "write_path", required_if("write", "true"))]
    write_path: Option<OsString>,

    #[command(group = "mode")]
    /// 传输模式：源路径
    from: Option<OsString>,

    #[command(group = "mode")]
    /// 传输模式：目标路径
    to: Option<OsString>,
}

fn main() {
    let cli = RsyncExample::parse();
    println!("{cli:?}");

    // 处理不同模式
    match (cli.read, cli.write, cli.from, cli.to) {
        (true, false, None, None) => {
            let file = cli.read_path.unwrap();
            println!("执行内部读取操作：{:?}", file);
            // 这里实现读取文件到stdout的逻辑
        }
        (false, true, None, None) => {
            let file = cli.write_path.unwrap();
            println!("执行内部写入操作：{:?}", file);
            // 这里实现从stdin写入文件的逻辑
        }
        (false, false, Some(from), Some(to)) => {
            println!("执行文件传输：从 {:?} 到 {:?}", from, to);
            // 这里实现传输逻辑，包括SSH调用远端程序的逻辑
        }
        _ => unreachable!("clap已经保证了参数的合法性"),
    }
}

关键修改说明： #

1. 统一参数组：创建mode参数组，强制用户只能选择一种运行模式（内部读取、内部写入、文件传输），确保互斥性。
2. flags与参数关联：用requires和required_if约束--read必须搭配read_path、--write必须搭配write_path，避免单独使用flags的非法情况。
3. 冲突规则：为--read和--write设置conflicts_with_all，确保它们不会与传输模式的from/to参数同时出现。
4. 精准错误提示：现在执行错误命令时，提示会更准确，例如：

$ cargo run -- --read
error: the argument '--read' requires an argument 'READ_PATH'

Usage: rsync-example --read <READ_PATH>

For more information, try '--help'.

$ cargo run -- --read file1 file2
error: the argument '--read' cannot be used with:
  <TO>

Usage: rsync-example --read <READ_PATH>

For more information, try '--help'.

合法命令测试： #

• 内部读取：cargo run -- --read test.txt → 正确解析read: true和read_path: Some("test.txt")
• 内部写入：cargo run -- --write output.txt → 正确解析write: true和write_path: Some("output.txt")
• 文件传输：cargo run -- ./local user@remote:/remote/file → 正确解析from: Some("./local")和to: Some("user@remote:/remote/file")

该方案无需额外程序链接，完全通过clap的参数约束实现需求，同时保证了错误提示的准确性和参数解析的正确性。

内容的提问来源于stack exchange，提问作者Kevin M Granger