Rust插件库Clio的使用：高效命令行IO工具库，优化文件操作与流处理

clio是一个用于解析CLI文件名的Rust库。

它实现了标准的Unix约定，当文件名为"-"时，将数据适当地发送到stdin/stdout。通过clap-parse特性，它还添加了许多有用的过滤器来验证来自命令行参数的路径，例如路径是否存在、是否为目录。

用法

Input和Output可以直接从args_os中的参数创建。如果由于任何原因无法打开文件，它们会报错。

// 一个cat替代品
fn main() -> clio::Result<()> {
    for arg in std::env::args_os().skip(1) {
        let mut input = clio::Input::new(&arg)?;  // 创建输入流
        std::io::copy(&mut input, &mut std::io::stdout())?;  // 复制到标准输出
    }
    Ok(())
}

如果您想延迟打开文件，可以使用InputPath和OutputPath。这可以避免在早期出错时留下空的输出文件。它们在创建时检查路径是否存在、是否为文件，并且理论上可以在获取时打开，以从clap获得更好的错误消息。由于这留下了TOCTTOU错误的余地，当实际打开文件时如果发生了变化，它们仍然会返回Err。

通过clap-parse特性，它们还设计用于clap 3.2+。

# #[cfg(feature="clap-parse")]{
use clap::Parser;
use clio::*;
use std::io::Write;

#[derive(Parser)]
#[clap(name = "cat")]
struct Opt {
    /// 输入文件，使用'-'表示stdin
    #[clap(value_parser, default_value="-")]
    input: Input,

    /// 输出文件，使用'-'表示stdout
    #[clap(long, short, value_parser, default_value="-")]
    output: Output,

    /// 存储日志文件的目录
    #[clap(long, short, value_parser = clap::value_parser!(ClioPath).exists().is_dir(), default_value = ".")]
    log_dir: ClioPath,
}

fn main() {
    let mut opt = Opt::parse();  // 解析命令行参数

    let mut log = opt.log_dir.join("cat.log").create().unwrap_or(Output::std_err());  // 创建日志文件

    match std::io::copy(&mut opt.input, &mut opt.output) {  // 复制输入到输出
        Ok(len) => writeln!(log, "Copied {} bytes", len),  // 写入成功信息
        Err(e) => writeln!(log, "Error {:?}", e),  // 写入错误信息
    };
}
# }

替代crate

Nameless

Nameless是clap的替代品，提供全服务的命令行解析。这意味着您只需编写一个带有所需类型参数的main函数，添加传统的文档注释，它就会使用过程宏的魔法来处理其余部分。

它的输入和输出流具有与clio相同的许多功能（例如’-'表示stdin），但也支持透明解压缩输入，以及更多远程选项，如scp://。

Patharg

如果您对这个crate中的代码量感到震惊，因为它应该是一个非常简单的任务，那么patharg是一个更轻量级的crate，可以与clap一起工作，将’-'视为stdin/stdout。

它不会打开文件，也不会在您询问之前验证路径，避免了TOCTTOU问题，但在此过程中失去了漂亮的clap错误消息。

它还避免了一大堆处理查找和预先猜测输入是否支持查找的复杂性。

还要注意，patharg没有自定义的clap ValueParser，因此旧版本的clap将通过String进行转换，因此路径需要是有效的utf-8，这在Linux和Windows中都不能保证。

Either

如果您真正需要的只是支持将'-'映射到stdin()，请尝试这个从patharg中提取的可爱函数。

它之所以有效，是因为either已经为许多常见特性添加了impl，当双方都实现它们时。

    use either::Either;
    use std::io;
    use std::ffi::OsStr;
    use std::fs::File;

    pub fn open(path: &OsStr) -> io::Result<impl io::BufRead> {
        Ok(if path == "-" {
            Either::Left(io::stdin().lock())  // 标准输入
        } else {
            Either::Right(io::BufReader::new(File::open(path)?))  // 文件输入
        })
    }

相应的create函数留给读者作为练习。

特性

clap-parse

为所有类型实现ValueParserFactory，并为所有类型添加一个不好的[Clone]实现，以保持clap满意。

HTTP客户端

如果将URL传递给Input::new，它将执行HTTP GET。与仅通过curl输出管道相比，这样做的优点是您知道输入大小，并且可以推断相关URL，例如获取与Cargo.toml匹配的Cargo.lock。

如果将URL传递给Output::new，它将执行HTTP PUT。与仅通过curl管道相比，主要优点是您可以使用OutputPath::create_with_len在上传开始之前设置大小，例如，如果您要将文件发送到S3，则需要这样做。

http-ureq

捆绑了ureq作为HTTP客户端。

http-curl

捆绑了curl作为HTTP客户端。

完整示例代码

// 使用clio实现cat功能的完整示例
use clap::Parser;
use clio::*;
use std::io::Write;

#[derive(Parser)]
#[clap(name = "cat", version = "1.0", about = "A cat implementation using clio")]
struct Opt {
    /// Input file, use '-' for stdin
    #[clap(value_parser, default_value = "-")]
    input: Input,

    /// Output file, use '-' for stdout
    #[clap(long, short, value_parser, default_value = "-")]
    output: Output,

    /// Directory for log files
    #[clap(long, value_parser = clap::value_parser!(ClioPath).exists().is_dir(), default_value = ".")]
    log_dir: ClioPath,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut opt = Opt::parse();
    
    // 创建日志文件，如果失败则使用标准错误输出
    let mut log = opt.log_dir.join("cat.log").create().unwrap_or(Output::std_err());
    
    // 复制输入到输出并记录结果
    match std::io::copy(&mut opt.input, &mut opt.output) {
        Ok(len) => {
            writeln!(log, "Successfully copied {} bytes", len)?;
            println!("Copied {} bytes", len);
        }
        Err(e) => {
            writeln!(log, "Error occurred: {:?}", e)?;
            eprintln!("Error: {:?}", e);
        }
    };
    
    Ok(())
}

要使用此代码，需要在Cargo.toml中添加依赖：

[dependencies]
clio = { version = "0.3", features = ["clap-parse"] }
clap = { version = "4.0", features = ["derive"] }