缩进文档 (indoc)

此crate提供了一种用于缩进字符串字面量的过程宏。宏 indoc!() 接受多行字符串字面量并将其取消缩进，使得最左侧的非空格字符位于第一列。

[dependencies]
indoc = "0.3"

发布说明可在 GitHub发布 下找到。

使用Indoc

use indoc::indoc;

fn main() {
    let testing = indoc!("
        def hello():
            print('Hello, world!')

        hello()
        ");
    let expected = "def hello():\n    print('Hello, world!')\n\nhello()\n";
    assert_eq!(testing, expected);
}

Indoc还可以与原始字符串字面量一起使用

use indoc::indoc;

fn main() {
    let testing = indoc!(r#"
        def hello():
            print("Hello, world!")

        hello()
        "#);
    let expected = "def hello():\n    print(\"Hello, world!\")\n\nhello()\n";
    assert_eq!(testing, expected);
}

以及字节字符串字面量

use indoc::indoc;

fn main() {
    let testing = indoc!(b"
        def hello():
            print('Hello, world!')

        hello()
        ");
    let expected = b"def hello():\n    print('Hello, world!')\n\nhello()\n";
    assert_eq!(testing[..], expected[..]);
}

说明

以下规则描述了 indoc!() 宏的行为

1. 计算每行的前导空格数，忽略第一行和任何只包含空格的空行。
2. 取最小值。
3. 如果第一行是空的，即字符串以换行符开头，则删除第一行。
4. 从每行的开头删除计算出的空格数。

这意味着有几种格式化相同字符串的等效方法，因此请选择您喜欢的格式。以下所有格式均产生相同的字符串 "line one\nline two\n"

indoc!("            /      indoc!(             /      indoc!("line one
   line one        /         "line one        /               line two
   line two       /           line two       /                ")
   ")            /            ")            /

取消缩进

Indoc的缩进逻辑可在 unindent crate中找到。这可能对处理在编译时不是静态已知的字符串很有用。

该crate公开了两个函数

• unindent(&str) ->String
• unindent_bytes(&[u8]) -> Vec<u8>

use unindent::unindent;

fn main() {
    let indented = "
            line one
            line two";
    assert_eq!("line one\nline two", unindent(indented));
}

许可协议