Rust字符串处理库dedent的使用指南

dedent是一个实用的Rust库，专门用于处理多行字符串的缩进问题。它可以高效地去除字符串中不必要的缩进，同时保留相对缩进结构，非常适合处理代码生成、模板渲染或需要保持格式化的多行文本场景。

功能特点

• 自动检测并去除多行字符串的共同缩进
• 保留字符串内部的相对缩进结构
• 支持混合制表符和空格缩进
• 轻量级且无额外依赖

安装方法

在Cargo.toml中添加依赖：

[dependencies]
dedent = "0.2"

基本使用方法

去除共同缩进

use dedent::dedent;

fn main() {
    // 带有共同缩进的多行字符串
    let indented_text = "
        line one
        line two
        line three
    ";
    
    // 使用dedent去除共同缩进
    let dedented = dedent(indented_text);
    
    println!("{}", dedented);
    // 输出:
    // line one
    // line two
    // line three
}

保留内部缩进

use dedent::dedent;

fn main() {
    // 带有内部缩进的代码字符串
    let indented_text = "
        fn main() {
            println!(\"Hello, world!\");
        }
    ";
    
    // dedent会保留内部相对缩进
    let dedented = dedent(indented_text);
    
    println!("{}", dedented);
    // 输出:
    // fn main() {
    //     println!("Hello, world!");
    // }
}

高级用法

处理混合缩进

use dedent::dedent;

fn main() {
    // 混合使用制表符和空格的字符串
    let mixed_indent = "
    \tline with tab
        line with spaces
    ";
    
    println!("{}", dedent(mixed_indent));
    // 输出:
    // line with tab
    // line with spaces
}

与原始字符串字面量结合使用

use dedent::dedent;

fn main() {
    // 使用原始字符串字面量(r#)包含多行代码
    let code = dedent(r#"
        pub struct Person {
            name: String,
            age: u32,
        }
        
        impl Person {
            pub fn new(name: &str, age: u32) -> Self {
                Person {
                    name: name.to_string(),
                    age,
                }
            }
        }
    "#);
    
    println!("{}", code);
}

完整示例代码

use dedent::dedent;

fn main() {
    // 示例1: 基本缩进去除
    let example1 = dedent("
        Hello,
            World!
    ");
    println!("示例1:\n{}", example1);

    // 示例2: 代码块处理
    let example2 = dedent(r#"
        fn greet(name: &str) {
            println!("Hello, {}!", name);
            if name == "Rust" {
                println!("Welcome!");
            }
        }
    "#);
    println!("\n示例2:\n{}", example2);

    // 示例3: 混合缩进处理
    let example3 = dedent("
    \tTab indented line
        Space indented line
      \tMixed indentation
    ");
    println!("\n示例3:\n{}", example3);

    // 示例4: 包含空行的处理
    let example4 = dedent("
        First line

        Third line
            Indented line
    ");
    println!("\n示例4:\n{}", example4);
}

使用场景

1. 代码生成：保持生成的代码格式整洁
2. 模板渲染：处理模板中的多行文本
3. 测试断言：格式化多行预期输出
4. 文档生成：保持示例代码的缩进

注意事项

• 空行不会影响共同缩进的计算
• 如果字符串中的所有行都为空，则返回空字符串
• 如果字符串中的行使用不一致的缩进，会以最小缩进为准

dedent库是处理多行字符串缩进的理想选择，它能帮助开发者保持代码整洁，同时减少手动处理字符串格式的工作量。