Rust系统退出码管理库sysexits使用指南

概述

sysexits库为Rust程序提供了标准化的Unix/C风格程序退出状态码常量定义，帮助开发者编写符合Unix惯例的命令行应用程序。

主要特性

• 提供符合sysexits.h标准的退出码常量
• 类型安全的ExitCode枚举
• 支持直接转换为std::process::ExitCode
• 清晰的错误分类和语义含义

安装方法

在Cargo.toml中添加依赖：

[dependencies]
sysexits = "0.3"

基本使用方法

1. 导入库

use sysexits::ExitCode;
use std::process;

2. 使用预定义退出码

fn main() {
    // 成功退出
    if everything_ok() {
        process::exit(ExitCode::Ok.into());
    }
    
    // 命令行用法错误
    if invalid_arguments() {
        process::exit(ExitCode::Usage.into());
    }
    
    // 数据格式错误
    if data_corrupted() {
        process::exit(ExitCode::DataErr.into());
    }
}

3. 完整示例

use sysexits::ExitCode;
use std::process;
use std::env;

fn main() {
    let args: Vec<String> = env::args().collect();
    
    if args.len() < 2 {
        eprintln!("Usage: {} <filename>", args[0]);
        process::exit(ExitCode::Usage.into());
    }
    
    let filename = &args[1];
    let content = match std::fs::read_to_string(filename) {
        Ok(content) => content,
        Err(e) => {
            eprintln!("Cannot read file {}: {}", filename, e);
            process::exit(ExitCode::NoInput.into());
        }
    };
    
    if content.trim().is_empty() {
        eprintln!("File is empty");
        process::exit(ExitCode::DataErr.into());
    }
    
    println!("File content: {}", content);
    process::exit(ExitCode::Ok.into());
}

完整示例demo

use sysexits::ExitCode;
use std::process;
use std::env;
use std::fs;
use std::io;

// 自定义错误处理函数
fn handle_file_operation(filename: &str) -> Result<String, ExitCode> {
    // 检查文件是否存在
    if !fs::metadata(filename).is_ok() {
        eprintln!("错误：文件 '{}' 不存在", filename);
        return Err(ExitCode::NoInput);
    }
    
    // 读取文件内容
    let content = match fs::read_to_string(filename) {
        Ok(content) => content,
        Err(e) if e.kind() == io::ErrorKind::PermissionDenied => {
            eprintln!("错误：没有权限读取文件 '{}'", filename);
            return Err(ExitCode::NoPerm);
        }
        Err(e) => {
            eprintln!("错误：读取文件 '{}' 失败: {}", filename, e);
            return Err(ExitCode::IoErr);
        }
    };
    
    // 检查文件内容是否为空
    if content.trim().is_empty() {
        eprintln!("警告：文件 '{}' 内容为空", filename);
        return Err(ExitCode::DataErr);
    }
    
    Ok(content)
}

// 处理命令行参数
fn parse_arguments(args: &[String]) -> Result<String, ExitCode> {
    if args.len() != 2 {
        eprintln!("用法：{} <文件名>", args[0]);
        return Err(ExitCode::Usage);
    }
    
    Ok(args[1].clone())
}

fn main() {
    // 获取命令行参数
    let args: Vec<String> = env::args().collect();
    
    // 解析参数
    let filename = match parse_arguments(&args) {
        Ok(filename) => filename,
        Err(exit_code) => {
            process::exit(exit_code.into());
        }
    };
    
    // 处理文件操作
    match handle_file_operation(&filename) {
        Ok(content) => {
            // 成功读取文件内容
            println!("文件内容：\n{}", content);
            process::exit(ExitCode::Ok.into());
        }
        Err(exit_code) => {
            process::exit(exit_code.into());
        }
    }
}

// 单元测试
#[cfg(test)]
mod tests {
    use super::*;
    use std::fs::File;
    use std::io::Write;
    use tempfile::NamedTempFile;

    #[test]
    fn test_file_reading_success() {
        let mut temp_file = NamedTempFile::new().unwrap();
        writeln!(temp_file, "测试内容").unwrap();
        
        let result = handle_file_operation(temp_file.path().to_str().unwrap());
        assert!(result.is_ok());
    }

    #[test]
    fn test_file_not_exists() {
        let result = handle_file_operation("nonexistent_file.txt");
        assert_eq!(result.err(), Some(ExitCode::NoInput));
    }
}

常用退出码常量

最佳实践

1. 使用有意义的退出码：不要总是返回0或1，使用具体的错误代码
2. 错误信息输出到stderr：将错误信息输出到标准错误流
3. 文档说明：在程序文档中说明可能返回的退出码含义

注意事项

• 退出码范围应在0-255之间
• 退出码0始终表示成功
• 非零退出码表示不同程度的错误
• 遵循Unix惯例有助于脚本编写和自动化

通过使用sysexits库，您可以编写出更加专业和符合Unix惯例的命令行应用程序。