Rust项目中Clap Parser派生宏编译失败问题排查

我在Rust中创建项目，想要使用clap库添加命令行解析器，但项目构建失败。

相关代码（args.rs） #

use clap::Parser;

/// Simple program to greet a person
#[derive(Parser, Debug)]
#[clap(author, version, about, long_about = None)]
pub struct Args {
    /// Optional name to operate on
    #[clap(short, long, value_parser)]
    width: usize,

    /// Sets a custom config file
    #[clap(short, long, value_parser)]
    height: usize,

    /// Turn debugging information on
    #[clap(short, long, value_parser)]
    mines: u8,
}

Cargo.toml配置 #

[package]
name = "rustymines"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
rand = "*"
grid = { git = "https://github.com/conqp/grid.git", branch = "main" }
clap = { version = "3.2.22", features = ["derive"] }

编译错误信息 #

$ cargo build
   Compiling libc v0.2.133
   Compiling version_check v0.9.4
   Compiling proc-macro2 v1.0.44
   Compiling unicode-ident v1.0.4
   Compiling quote v1.0.21
   Compiling syn v1.0.101
   Compiling cfg-if v1.0.0
   Compiling autocfg v1.1.0
   Compiling ppv-lite86 v0.2.16
   Compiling heck v0.4.0
   Compiling os_str_bytes v6.3.0
   Compiling hashbrown v0.12.3
   Compiling termcolor v1.1.3
   Compiling once_cell v1.15.0
   Compiling strsim v0.10.0
   Compiling bitflags v1.3.2
   Compiling textwrap v0.15.1
   Compiling grid v0.1.0 (https://github.com/conqp/grid.git?branch=main#227750b9)
   Compiling proc-macro-error-attr v1.0.4
   Compiling proc-macro-error v1.0.4
   Compiling clap_lex v0.2.4
   Compiling indexmap v1.9.1
   Compiling getrandom v0.2.7
   Compiling atty v0.2.14
   Compiling rand_core v0.6.4
   Compiling rand_chacha v0.3.1
   Compiling rand v0.8.5
   Compiling clap_derive v3.2.18
   Compiling clap v3.2.22
   Compiling rustymines v0.1.0 (/home/rne/Projekte/rustymines)
error[E0616]: field `width` of struct `args::Args` is private
  --> src/game.rs:26:24
   |
26 |         Self::new(args.width, args.height, args.mines)
   |                        ^^^^^ private field

error[E0616]: field `height` of struct `args::Args` is private
  --> src/game.rs:26:36
   |
26 |         Self::new(args.width, args.height, args.mines)
   |                                    ^^^^^^ private field

error[E0616]: field `mines` of struct `args::Args` is private
  --> src/game.rs:26:49
   |
26 |         Self::new(args.width, args.height, args.mines)
   |                                                 ^^^^^ private field

error[E0599]: no function or associated item named `parse` found for struct `args::Args` in the current scope
  --> src/game.rs:30:26
   |
30 |         let args = Args::parse();
   |                          ^^^^^ function or associated item not found in `args::Args`
   |
  ::: src/game/args.rs:6:1
   |
6  | pub struct Args {
   | --------------- function or associated item `parse` not found for this
   |
   = help: items from traits can only be used if the trait is in scope
help: the following trait is implemented but not in scope; perhaps add a `use` for it:
   |
1  | use clap::Parser;
   |

Some errors have detailed explanations: E0599, E0616.
For more information about an error, try `rustc --explain E0599`.
error: could not compile `rustymines` due to 4 previous errors

Rust版本信息 #

$ rustup show
Default host: x86_64-unknown-linux-gnu
rustup home:  /home/rne/.rustup

stable-x86_64-unknown-linux-gnu (default)
rustc 1.63.0 (4b91a6ea7 2022-08-08)

注：按照clap文档，这些错误本不应出现，clap应自动让字段可访问并实现parse()方法，请问问题出在哪里？

1. 修复字段私有问题 #

clap的Parser派生宏不会自动将结构体字段设为公共，Rust默认字段私有。需要手动为Args的每个字段添加pub修饰符，确保其他模块（如game.rs）能访问这些字段：

pub struct Args {
    /// Optional name to operate on
    #[clap(short, long, value_parser)]
    pub width: usize,

    /// Sets a custom config file
    #[clap(short, long, value_parser)]
    pub height: usize,

    /// Turn debugging information on
    #[clap(short, long, value_parser)]
    pub mines: u8,
}

2. 修复parse方法找不到的问题 #

parse是clap::Parser trait提供的关联函数，必须确保该trait在使用的作用域内可见。在game.rs顶部添加：

use clap::Parser;

或者通过trait直接调用：

let args = clap::Parser::parse::<args::Args>();

补充说明 #

clap文档中提到的"自动实现parse方法"是指派生Parser后会为结构体实现该trait，但trait方法必须在trait可见时才能直接调用。而字段可见性遵循Rust默认规则，宏不会改变这一行为。

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