一、简单使用clap
yaml
clap = { version = "4.5.17", features = ["derive"] }
其中,什么是features = ["derive"]
:表示 你希望在添加 clap 依赖时启用 derive 特性。这通常意味着你希望使用 clap 的派生(derive)宏功能,这些功能可以简化创建命令行接口的代码。例如,derive 特性可以让你使用 #[derive(Parser)]
来自动生成解析命令行参数的代码。
二、简单示例
rust
use clap::Parser;
#[derive(Parser, Debug)]
#[command(version, about, long_about = None)]
struct Args {
#[clap(short, long)]
name: String,
#[arg(short, long, default_value_t = 1)]
count: u8,
}
fn main() {
let args = Args::parse();
for _ in 0..args.count {
println!("Hello {}!", args.name);
}
println!("Hello, world!");
}
三、宏
3.1 Rust宏系统
Rust 的宏系统允许你定义和使用宏,以生成代码。宏可以在编译时展开成 Rust 代码,这样你就能以更简洁的方式编写代码。Rust 提供了两种类型的宏:
声明宏 (Declarative Macros):
使用 macro_rules!
语法定义,可以匹配模式并生成代码。
过程宏 (Procedural Macros):
更复杂,可以对 Rust 代码进行复杂的操作,通常使用 #[derive(...)]
或 #[proc_macro]
来定义。
在 clap 库中,#[derive(Parser)]
和 #[command(...)]
是过程宏(procedural macros)
的实例,它们在编译时生成代码。
3.2 宏做了什么
宏为你的结构体自动实现了trait
,宏的实现是以 Rust 代码的形式存在的,但是它们通常被封装在外部 crate 中,并且在使用时,具体的宏实现是无法直接跳转查看的。编译器知道如何调用这些宏,但它不总是直接提供内部实现的源代码。
3.3 编译
Rust 的宏系统,特别是过程宏(如 #[derive(...)]
和 #[command(...)]
),在编译时生成了另外一套代码。
四、简单实现一个宏
这里的示例,帮助理解宏的用法。
比如实现打印一个自定义结构体
如果有一个自定义的结构体,正常println!
是并不支持打印任意内容的,这时可以自己实现一个例如to_string
的方法将自己的结构体转成String
就可以了,如:
rust
use my_macros::ToString;
#[derive(ToString)]
struct Person {
name: String,
age: u32,
}
fn main() {
let p = Person {
name: "Alice".to_string(),
age: 30,
};
println!("{}", p.to_string());
}
其中实现:
rust
use proc_macro::TokenStream;
use quote::quote;
use syn::{parse_macro_input, DeriveInput};
#[proc_macro_derive(ToString)]
pub fn to_string_derive(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
let name = &input.ident;
let fields = if let syn::Data::Struct(syn::DataStruct { fields, .. }) = input.data {
fields
} else {
panic!("ToString only works on structs");
};
let field_strings = fields.iter().map(|field| {
let name = &field.ident;
quote! {
format!("{}: {:?}", stringify!(#name), self.#name)
}
});
let expanded = quote! {
impl #name {
pub fn to_string(&self) -> String {
let mut result = String::new();
#(
result.push_str(&format!("{} ", #field_strings));
)*
result
}
}
};
TokenStream::from(expanded)
}
有点类似cpp
的宏定义,cpp
的宏定义就是单纯的字符串替换,Rust
虽说本质上也是单纯的字符串替换,但是Rust
的宏展开是编译器功能的一部分,提供了更强大的代码生成能力和更高的安全性。
五、调试启动传递命令内容
如果使用例如RustRover
调试启动一个带命令行内容的程序,如下:
shell
cargo run -- --name Rust --count 5
在--
后填写内容。