如果某个参数可以接受多个，则通过集合定义类型

#[derive(Parser)]pub struct Config {    name: Vec,}

在命令执行多余的参数会解析到字段 name 中。隐式的启动了#[arg(action = ArgAction::Set)],处理多个值。

使用标志命名参数

在之前的实例中，已经使用了#[arg(short, long)],它用来标识参数名称，它可以：

• 意图表达更明确
• 不用在意参数的顺序
• 使参数变的可选

#[derive(Parser)]pub struct Config {    #[arg(short, long)]    pub search: String,    #[arg(short, long)]    pub file_path: String,    #[arg(short, long)]    pub ignore_case: bool,}

可以通过--help查看变化，所有的参数都变成了Options

子命令

在执行ifun-grep时，携带子命令执行。通过#[derive(Subcommand)]标志属性，子命令也可以有自己的版本、作者信息、参数等等

use clap::{Args, Parser, Subcommand};#[derive(Parser)]pub struct Config {    #[arg(short, long)]    pub search: String,    #[arg(short, long)]    pub file_path: String,    #[arg(short, long)]    pub ignore_case: bool,    #[command(subcommand)]    pub command: Commands,}#[derive(Subcommand)]pub enum Commands {    Add(AddArgs),}#[derive(Args)]pub struct AddArgs {    name: Option,}

默认值

可以通过#[arg(default_value_t)]定义默认值,定义字段file_path默认值

#[derive(Parser)]pub struct Config {    #[arg(short, long)]    pub search: String,    #[arg(short, long, default_value = "hello.txt")]    pub file_path: String,    #[arg(short, long)]    pub ignore_case: bool,}

调用命令执行时，可以不在设置该字段

$> target/debug/ifun-grep -s Let

命令执行是查询成功的.

其他的功能比如：数据校验、自定义值解析逻辑、自定义校验等等。

anyhow处理错误

提供了一种错误类型anyhow::Error. 处理出现的错误。

之前处理文件读取的逻辑，使用了?

pub fn run(config: Config) -> Result<(), Box> {    let content = fs::read_to_string(config.file_path)?;    Ok(())}

当文件不存在时，会打印出错误信息something error:No such file or directory (os error 2).但不知道具体哪个文件不存在。

可以通过自定义错误类型IfunError，来构建自己的错误信息

#[derive(Debug)]pub struct IfunError(String);pub fn run(config: Config) -> Result<(), IfunError> {    let file_path = config.file_path.clone();    let content = fs::read_to_string(config.file_path)        .map_err(|err| IfunError(format!("could not read file {} - {}", file_path, err)))?;    // ...    Ok(())}

再次执行访问不存在的文件，报错信息为something error:IfunError("could not read file 1.txt - No such file or directory (os error 2)")

而anyhow正好做了事情，可以通过 anyhow 的特征context可以附加错误内容信息，也保留了原始错误。

安装 crate anyhow库

$> cargo add anyhow

调整处理读取文件的函数run,在src/lib.rs文件中修改：

use anyhow::{Context, Result};pub fn run(config: Config) -> Result<()> {    let file_path = config.file_path.clone();    let content = fs::read_to_string(config.file_path)        .with_context(|| format!("could not read file {}", file_path))?;    // ...    Ok(())}

还需要修改src/main.rs文件，将错误输出方式改为{:?}

fn main() {    // ...    if let Err(e) = run(config) {        // println!("something error:{e}");        eprintln!("something error:{:?}", e);        process::exit(1);    }}

再次执行命令，可以看到错误更加的友好。

使用anyhow!()宏，输出错误信息

在src/main.rs，读取文件之前增加错误输出

fn main(){    // ...    println!("{}", anyhow!("anyhow error {}", "running"));    //...}

使用bail!()宏，中断执行

调用执行返回错误，中断程序执行

在src/main.rs，读取文件之前增加错误输出

use anyhow::{anyhow, bail};fn main() -> Result<(), anyhow::Error> {    // ...    println!("{}", anyhow!("anyhow error {}", "running"));    bail!("permission denied for accessing {}", config.file_path)    //...}

调用bail!时，返回值必须是Result<(), anyhow::Error>类型

bail!同等于return Err(anyhow!())

跟踪错误栈

打印出错误信息，我们可以知道发生了错误，想知道是哪个文件、那行代码发生的错误，则需要开启错误栈追踪。

这是一个特性功能，需要指定特性启用

$> cargo add anyhow --features backtrace

然后通过设置环境变量，

• RUST_BACKTRACE=1panics和 error 都有错误栈输出
• RUST_LIB_BACKTRACE=1仅打开错误输出
• RUST_BACKTRACE=1和RUST_LIB_BACKTRACE=0仅 panic 时

在执行命令时，设置环境变量，打开错误输出时的错误追踪

$> RUST_LIB_BACKTRACE=1 cargo run -- -s let -f 1.txt

thiserror自定义自己的错误类型

与anyhow不同，thiserror可以用来自定义错误类型。

通过过程式宏#[derive(Error)],它是由 std::error::Error派生而来。

$> cargo add thiserror

定义一个文件不能存在的错误类型，并用于读取文件时的逻辑

use thiserror::Error;#[derive(Error, Debug)]pub enum IfunError {    #[error("the file is"t exist")]    FileNotExist(#[from] std::io::Error),}pub fn run(config: Config) -> Result<(), IfunError> {    let content = fs::read_to_string(config.file_path)?;    // ...    Ok(())}

执行命令，访问不存在的文件。错误信息输出会被自定义的类型包裹：

ansi_term更好的打印输出

ansi_term控制台上的打印输出，包括字体样式、格式化。

安装

$> cargo add ansi_term

包括对文本的字体颜色、背景色、是否加粗、是否闪烁等等。

通过ansi_term::Colour控制字体样式

我们将ifun-grep的 参数打印使用颜色标记输出

use ansi_term::Colour::{Green, Yellow};fn main(){    //...    println!(        "will search {} in {}",        Green.paint(&config.search),        Yellow.paint(&config.file_path)    );}

执行命令cargo run -- -s Let -f hello.txt

加粗bold()、加下划线underline()、背景色on()等

use ansi_term::Colour::{Green, Yellow};fn main(){    //...    println!(        "will search {} in {}",        Green.bold().paint(&config.search),        Yellow.underline().paint(&config.file_path)    );}

给程序查询出的行数据加背景色、闪烁

use ansi_term::Colour::{Red, Yellow};pub fn run(config: Config) -> Result<(), anyhow::Error> {    //...    for line in result {        println!("{}", Red.on(Yellow).blink().paint(line));    }    Ok(())}

通过ansi_term::Style控制样式

Colour是一个枚举类型，专门针对颜色样式处理；Style是结构体类型，是字体样式的集合。

设置字体颜色,结构体需要实例化一个实例对象，然后再调用对应的方法。

use ansi_term::Colour::{Green, Yellow};use ansi_term::Style;fn main(){    //...    println!(        "will search {} in {}",        Green.bold().paint(&config.search),        // Yellow.underline().paint(&config.file_path)        Style::new().fg(Yellow).paint(&config.file_path)    );}

颜色扩展ansi_term::Colour::Fixed

除了内置枚举的颜色，还可以通过色码值设置颜色。0-255

use ansi_term::Colour::Fixed;Fixed(154).paint("other color");

也可以通过ansi_term::Colour::RGB，设置三个不同的值

use ansi_term::Colour::RGB;RGB(154, 56, 178).paint("other color");

此外还有内置ANSIStrings类型，可以通过to_string()方法转换为String;

支持格式化输出\[u8]字节字符串，对于不知道编码的文本输出很有用。会生成ANSIByteString类型，通过write_to方法写入输出流中。

Green.paint("ansi_term".as_bytes()).write_to(&mut std::io::stdout()).unwrap();

indicatif展示进度条

处理任务时，显示任务的执行进度。会让人感觉良好，更有耐心等待执行完毕

$> cargo add indicatif

手动创建一个进度条,为了看到进度条的进度效果，可以使用std::thred线程休眠一段时间。

use indicatif::ProgressBar;use std::{thread, time};fn main(){    let bar = ProgressBar::new(100);    let ten_millis = time::Duration::from_millis(10);    for _ in 0..100 {        bar.inc(1);        thread::sleep(ten_millis);        // ...    }    bar.finish();}

通过ProgressBar类型创建了一个进度条的实例对象，然后通过实例bar.inc()逐步增加进度。完成后调用bar.finish()表示进度完成，并保留显示进度信息。

也支持多进度条的MultiProgress

log日志记录

一个程序运行时期的日志打印，非常重要，这对于运行监测喝解决有问题都有很到的帮助。

$> cargo add log

通常可以将日志按照登记划分，比如错误、警告、信息等。还需要一个日志输出的适配器 env_logger，可以将日志写入终端、日志服务器等。

$> cargo add env_logger

美化输出，将接受到的参数作为信息info!()输出，将产生的错误使用error!()输出

env_logger默认输出日志到终端，

use log;fn main() {    env_logger::init();    // ...    log::info!(        "will search {} in {}",        Green.bold().paint(&config.search),        Style::new().fg(Yellow).paint(&config.file_path)    );    // ...    if let Err(e) = run(config) {        log::error!("something error:{:?}", e);        process::exit(1);    }}

必须在程序之前初始化完毕日志环境变量配置。默认只展示error错误类型的日志

执行cargo run -- -s Let -f 1.txt命令访问不存在的文件，可以看到只有 error 错误输出打印。

通过设置变量RUST_LOG=info,查看

$> RUST_LOG=info cargo run -- -s Let -f 1.txt

初始化指定信息类型

在执行命令前加上RUST_LOG=info很麻烦，有遗忘的可能，可以通过初始化env_logger::init()调用时，设定一个默认值

use env_logger::Env;fn mian(){    env_logger::Builder::from_env(Env::default().default_filter_or("info")).init();    // ...}

通过终端设置的变量优先级比默认值高，可以通过执行时设置变量覆盖默认值。

自定义输出模板

可以看到默认的输出打印包括了时间、类型以及模块名。可以通过改变模板自定义输出格式

use std::io::Write;fn main(){    env_logger::builder()        .format(|buf, record| writeln!(buf, "{} - {}", record.level(), record.args()))        .init();}

输出格式改变为信息类型 - 信息。使用默认的挺好，现在好多编辑器的日志输出都是这种格式。

测试

之前的单元测试示例都是和逻辑代码放在一起的，并用#[test]注释。可以将这些测试放在tests目录中

新建tests/lib.rs用于存放单元测试用例。

use ifun_grep::{find, find_insensitive};#[test]fn case_sensitive() {    let search = "rust";    let content = "\nice. rustI"m hboot.hello world.Rust";    assert_eq!(vec!["nice. rust"], find(search, content));}#[test]fn case_insensitive() {    let search = "rust";    let content = "\nice. rustI"m hboot.hello world.Rust";    assert_eq!(        vec!["nice. rust", "Rust"],        find_insensitive(search, content)    );}

通过借助第三饭库来使得测试更容易，

assert_cmd

可以处理结果进行断言；也可以测试调用命令进行测试。一起配合使用的还有predicates用来断言布尔值类型结果值

因为测试示例只在开发阶段需要，则在安装时加参数--dev

$> cargo add assert_cmd predicates --dev

新增一个处理文件不存在的的测试示例。日志打印输出时会包含有could not read file字符串。

use assert_cmd::prelude::*;use ifun_grep::{find, find_insensitive};use predicates::prelude::*;use std::{error::Error, process::Command};#[test]fn file_doesnt_exist() -> Result<(), Box> {    let mut cmd = Command::cargo_bin("ifun-grep")?;    cmd.arg("-s let").arg("-f 1.txt");    cmd.assert()        .failure()        .stderr(predicate::str::contains("could not read file"));    Ok(())}

通过运行cargo test,测试示例是运行成功的。

assert_fs用于测试文件系统的断言

刚才测试了文件不存在的错误输出，还需要增加文件存在的测试，并写入内容。

$> cargo add assert_fs --dev

生成要测试的文件；断言测试生成的文件。tests/lib.rs增加测试用例

use assert_cmd::prelude::*;use assert_fs::prelude::*;use ifun_grep::{find, find_insensitive};use predicates::prelude::*;use std::{error::Error, process::Command};#[test]fn file_content_exist() -> Result<(), Box> {    let file = assert_fs::NamedTempFile::new("1.txt")?;    file.write_str("hello world \n Rust-web \n good luck for you!")?;    let mut cmd = Command::cargo_bin("ifun-grep")?;    cmd.arg("-s good").arg("-f").arg(file.path());    cmd.assert()        .success()        .stderr(predicate::str::contains("good luck for you!"));    Ok(())}

这样书写的单元测试用例更能直接、明了。和实际使用ifun-grep时同样的命令操作，而不是使用开发时运行cargo run

关键词：