uucore：Rust命令行工具开发的核心工具库

概述

uucore是Rust生态中专门为命令行工具开发设计的高效基础组件库。它提供了构建Unix/Linux命令行工具所需的通用功能模块，包括参数解析、错误处理、国际化支持等核心组件，帮助开发者快速构建健壮的命令行应用。

主要特性

• 命令行参数解析
• 统一的错误处理机制
• 国际化(i18n)支持
• 标准输入输出处理
• 文件系统操作辅助
• 跨平台兼容性

安装方法

在Cargo.toml中添加依赖：

[dependencies]
uucore = "0.0.4"

基本使用示例

1. 基础命令行应用

use uucore::error::UResult;

fn main() -> UResult<()> {
    // 初始化uucore
    uucore::panic::install_panic_hook();
    
    // 这里实现你的命令行逻辑
    println!("Hello from uucore!");
    
    Ok(())
}

2. 参数解析示例

use uucore::{show_usage_error, show_error};
use uucore::format_usage;

static USAGE: &str = "{} [OPTION]... FILE";

fn main() -> uucore::error::UResult<()> {
    let args = uucore::args();
    
    if args.len() < 2 {
        return show_usage_error!("missing file argument");
    }
    
    // 处理参数逻辑
    let file = &args[1];
    println!("Processing file: {}", file);
    
    Ok(())
}

3. 错误处理示例

use uucore::error::{UResult, UError};
use std::fs::File;

fn read_file(path: &str) -> UResult<String> {
    let mut file = File::open(path)
        .map_err(|e| UError::new(1, format!("无法打开文件: {}", e)))?;
    
    let mut contents = String::new();
    std::io::Read::read_to_string(&mut file, &mut contents)
        .map_err(|e| UError::new(1, format!("读取文件失败: {}", e)))?;
    
    Ok(contents)
}

fn main() -> UResult<()> {
    match read_file("example.txt") {
        Ok(content) => println!("文件内容: {}", content),
        Err(e) => return Err(e),
    }
    
    Ok(())
}

高级功能

国际化支持

use uucore::display::Quotable;

fn main() {
    let filename = "test.txt";
    println!("文件 {} 不存在", filename.maybe_quote());
}

进度显示

use uucore::progress::ProgressBar;

fn process_large_file() {
    let pb = ProgressBar::new(1000);
    for i in 0..1000 {
        // 处理逻辑
        pb.inc(1);
    }
    pb.finish();
}

完整示例demo

//! 完整的uucore命令行工具示例
//! 演示参数解析、错误处理、文件操作和进度显示

use uucore::error::{UResult, UError};
use uucore::progress::ProgressBar;
use uucore::display::Quotable;
use std::fs::File;
use std::io::{self, Write};

// 定义使用说明
static USAGE: &str = "{} [OPTIONS] <FILE>";

fn main() -> UResult<()> {
    // 安装panic钩子
    uucore::panic::install_panic_hook();
    
    // 获取命令行参数
    let args = uucore::args();
    
    // 参数检查
    if args.len() < 2 {
        return Err(UError::new(1, "缺少文件参数".to_string()));
    }
    
    let filename = &args[1];
    
    // 显示处理信息（使用国际化功能）
    println!("正在处理文件: {}", filename.maybe_quote());
    
    // 读取文件内容
    let content = read_file_with_progress(filename)?;
    
    // 显示文件内容
    println!("文件内容:");
    println!("{}", content);
    
    Ok(())
}

/// 带进度显示的文件读取函数
fn read_file_with_progress(path: &str) -> UResult<String> {
    // 打开文件
    let mut file = File::open(path)
        .map_err(|e| UError::new(2, format!("无法打开文件 {}: {}", path.maybe_quote(), e)))?;
    
    // 获取文件大小用于进度显示
    let metadata = file.metadata()
        .map_err(|e| UError::new(2, format!("获取文件元数据失败: {}", e)))?;
    let file_size = metadata.len();
    
    // 创建进度条
    let pb = ProgressBar::new(file_size);
    
    let mut contents = String::new();
    let mut buffer = [0; 1024];
    let mut total_read = 0;
    
    // 分块读取文件并更新进度
    loop {
        let bytes_read = file.read(&mut buffer)
            .map_err(|e| UError::new(2, format!("读取文件失败: {}", e)))?;
        
        if bytes_read == 0 {
            break;
        }
        
        // 将读取的内容添加到字符串
        contents.push_str(&String::from_utf8_lossy(&buffer[..bytes_read]));
        
        total_read += bytes_read as u64;
        pb.set(total_read);
    }
    
    pb.finish_with_message("文件读取完成");
    
    Ok(contents)
}

/// 文件写入函数（演示错误处理）
fn write_to_file(path: &str, content: &str) -> UResult<()> {
    let mut file = File::create(path)
        .map_err(|e| UError::new(3, format!("创建文件失败: {}", e)))?;
    
    file.write_all(content.as_bytes())
        .map_err(|e| UError::new(3, format!("写入文件失败: {}", e)))?;
    
    println!("成功写入文件: {}", path.maybe_quote());
    
    Ok(())
}

最佳实践

1. 始终使用UResult作为返回类型以获得统一的错误处理
2. 利用uucore提供的国际化功能
3. 使用内置的显示工具正确处理特殊字符
4. 遵循Unix命令行工具的开发惯例

uucore极大地简化了Rust命令行工具的开发过程，提供了生产级应用所需的基础设施，是开发高质量命令行工具的理想选择。