docstr 0.4.10

Ergonomic multi-line string literals
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

#![cfg(test)]
use docstr::docstr;

const AGE: u32 = 19;

#[test]
fn ui() {
    let t = trybuild::TestCases::new();
    t.compile_fail("tests/ui/*.rs");
}

#[test]
fn empty() {
    const A: &str = docstr!(
        ///
    );

    assert_eq!(A, "");
}

#[test]
fn full_path() {
    assert_eq!(
        docstr!(std::format!
            /// foo
            /// bar
        ),
        "foo\nbar"
    );
    assert_eq!(
        docstr!(::std::concat!
            /// foo
            /// bar
            "hello"
        ),
        "foo\nbarhello"
    );
}

/// Works with constants
#[test]
fn constant() {
    const A: &str = docstr!(
        /// foo
        /// bar
    );

    assert_eq!(A, "foo\nbar", "join with newline");

    const B: &str = docstr!(
        /// foo
        /// bar
        ///
    );

    assert_eq!(B, "foo\nbar\n", "newline at end");
}

/// Can do string interpolation
#[test]
fn format() {
    assert_eq!(
        docstr!(format!
            /// Hello, my name is {}
            /// and I am {AGE} years old
            "Bob"
        ),
        format!("Hello, my name is Bob\nand I am {AGE} years old")
    );
}

/// NO macro, but `{}`
#[test]
fn fake_interpolation() {
    assert_eq!(
        docstr!(
            /// I am {AGE} years old
        ),
        "I am {AGE} years old"
    );
}

/// String interpolation using a custom macro
#[test]
fn formatln() {
    macro_rules! formatln {
        ($($tt:tt)*) => {
            format!($($tt)*) + "\n"
        };
    }

    assert_eq!(
        docstr!(
            formatln!
            /// Hello, my name is {}
            /// and I am {AGE} years old
            "Bob"
        ),
        format!("Hello, my name is Bob\nand I am {AGE} years old\n")
    );
}

/// Accepts arguments before the string
#[test]
fn writeln() {
    let name = "dave";

    use std::fmt::Write as _;
    let mut s = String::new();

    docstr!(writeln! s
        /// hello
        /// {name}
    )
    .unwrap();

    assert_eq!(s, "hello\ndave\n");

    // Same, but a comma after `s`

    let mut s = String::new();
    docstr!(writeln! s,
        /// hello
        /// {} {}
        name, name
    )
    .unwrap();

    assert_eq!(s, "hello\ndave dave\n");
}

#[test]
fn escape() {
    assert_eq!(
        docstr!(
            /// hello "world" ' \ ! ()
            /// ///\\/\// \u{0032}
        ),
        "hello \"world\" ' \\ ! ()\n///\\\\/\\// \\u{0032}"
    );
}