Rust轻量级插件库chic的使用：高效扩展Rust功能的模块化工具包

安装

$ cargo add chic

或者在你的Cargo.toml中添加：

chic = "1.2.2"

安全性

这个crate使用了#![deny(unsafe_code)]来确保所有代码都是100%安全的Rust实现。

示例使用

以下是使用chic库的基本示例：

use chic::{Error, Report};

fn main() -> Result<(), Report> {
    // 创建一个简单的错误报告
    let report = Error::new("Something went wrong")
        .with_label("this is the problem area", 0..10);
    
    // 打印错误报告
    eprintln!("{}", report);
    
    Ok(())
}

完整示例

下面是一个更完整的示例，展示如何使用chic来创建详细的解析错误报告：

use chic::{Error, Report, Label};

fn parse_input(input: &str) -> Result<(), Report> {
    if input.is_empty() {
        return Err(Error::new("Empty input")
            .with_label("expected input here", 0..0)
            .with_note("Input cannot be empty"));
    }

    if !input.starts_with('#') {
        return Err(Error::new("Invalid format")
            .with_label("expected '#' at start", 0..1)
            .with_label("this is where the error occurred", 0..input.len())
            .with_note("Input must start with '#' character"));
    }

    Ok(())
}

fn main() {
    let test_cases = vec!["", "hello", "#valid"];

    for input in test_cases {
        println!("Testing input: {:?}", input);
        if let Err(report) = parse_input(input) {
            eprintln!("Error:\n{}", report);
        } else {
            println!("Input is valid");
        }
        println!();
    }
}

完整示例demo

下面是一个更详细的示例，展示chic库在实际项目中的使用：

use chic::{Error, Report, Label};

// 验证用户输入的函数
fn validate_user_input(input: &str) -> Result<(), Report> {
    // 检查输入长度
    if input.len() < 5 {
        return Err(Error::new("Input too short")
            .with_label("minimum 5 characters required", 0..input.len())
            .with_note("Please provide longer input"));
    }
    
    // 检查是否包含数字
    if !input.chars().any(|c| c.is_ascii_digit()) {
        return Err(Error::new("Missing digit")
            .with_label("expected at least one digit here", 0..input.len())
            .with_note("Password must contain at least one number"));
    }
    
    // 检查是否包含特殊字符
    if !input.chars().any(|c| !c.is_ascii_alphanumeric()) {
        return Err(Error::new("Missing special character")
            .with_label("expected special character like !@#", 0..input.len())
            .with_note("Password must contain at least one special character"));
    }
    
    Ok(())
}

fn main() {
    let inputs = vec!["short", "longenough", "with1number", "valid!123"];
    
    for input in inputs {
        println!("Validating: {:?}", input);
        match validate_user_input(input) {
            Ok(_) => println!("✅ Input is valid"),
            Err(report) => {
                println!("❌ Validation failed:");
                eprintln!("{}", report);
            }
        }
        println!();
    }
}

贡献

如果你想参与贡献，可以查看项目的问题列表：

• 标记为"good first issue"的问题
• 标记为"help wanted"的问题

许可证

本项目采用以下任一许可证：

• Apache License, Version 2.0
• MIT license

除非你明确声明，否则任何有意提交到本项目的贡献都将按上述双重许可授权，不附加任何额外条款或条件。