pprint

一个用于使用文档模型进行美化打印的Rust库。自动为结构体、枚举和基本类型派生 Pretty；默认支持向量类型和映射类型；与 derive(Debug) 宏非常相似，但更美观且可配置。

用法

use pprint::{Doc, Printer, PRINTER};

let doc = Doc::from(vec![1, 2, 3])
    .wrap("[", "]")
    .join(", ");

print!("{}", PRINTER.pretty(doc));
// prints:
// [
//   1,
//   2,
//   3
// ]

文档模型

文档模型提供了一组丰富的构建块

• 原始值，如字符串、数字
• 容器，如向量、元组、映射、集合
• 格式化，如 concat、join、wrap、group
• 使用 indent 和 dedent 控制缩进
• 使用 if_break 进行条件格式化
• 如 hardline、softline 一样进行换行

Printer 处理将 Doc 美化打印到字符串，具有可配置的选项

• max_width - 每行的最大宽度
• indent - 每个缩进级别的空格数
• break_long_text - 在长文本中插入换行符
• use_tabs - 使用制表符代替空格进行缩进

派生宏

库的一半开发时间用于派生宏，使得几乎任何类型的输出都可以轻松进行美化打印。以下是一个简单的示例

#[derive(Pretty)]
struct Point {
    x: f64,
    y: f64
}

let point = Point { x: 1.0, y: 2.0 };
print!("{}", Doc::from(point)); // prints "(x: 1, y: 2)"

Pretty 支持一个额外的属性，pprint，用于自定义对象的美化打印定义。以下选项可用

• skip: bool: 跳过此字段 - 不要将其包含在输出中
• indent: bool: 缩进此字段 - 在前后添加换行和缩进
• rename: Option: 重命名此字段 - 使用给定的字符串作为字段名
• getter: Option: 使用给定的函数获取此字段的值
• verbose: bool: 详细输出 - 在输出中包含字段名

#[derive(Pretty)]
#[pprint(verbose)]
struct Point {
    #[pprint(rename = "x-coordinate")]
    x: f64,
    #[pprint(rename = "y-coordinate")]
    y: f64
    #[pprint(skip)]
    _skip_me: bool,
}

let point = Point { x: 1.0, y: 2.0, _skip_me: true };
print!("{}", Doc::from(point));
// prints:
// Point {
//   x-coordinate: 1,
//   y-coordinate: 2
// }

结构体可以是任意嵌套的，& c. & c. 更复杂的示例可以在 测试 文件中找到。