macropol 0.1.4

Ergonomic string literal interpolation in macro definitions
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

# 🚨 macropol

Ergonomic string literal interpolation in macro definitions.

Replaces metavariables (`$foo`) and arbitrary expressions in string literals (including doc comments) and concatenates them with surrounding text fragments with `core::concat!`.

## Syntax Overview

| Syntax      | Output             | Notes                                  |
| ----------- | ------------------ | -------------------------------------- |
| `"$foo"`    | `$foo`             | `$foo` must expand to a string literal |
| `"$&foo"`   | `stringify!($foo)` |                                        |
| `"${bar}"`  | `bar`              | `bar` must expand to a string literal  |

## Example

```rust
#[macropol::macropol]
macro_rules! mymacro {
    ($count:expr, $name:literal, fn $func:ident()) => {
        /// Returns `"$$ $name, $&count to beam up"`.
        fn $func() -> &'static str {
            "$$ $name, ${stringify!($count)} to beam up"
        }
    };
}

// The above definition expands to:
//
//     macro_rules! mymacro {
//         ($count:expr, $name:expr, fn $func:ident()) => {
//             #[doc = concat!("Returns `\"$ ", $name, ", ",
//                  stringify!($count), " to beam up\"`.")]
//             fn func() -> &'static str {
//                 concat!("$ ", $name, ", ",
//                     stringify!($count), " to beam up")
//             }
//         };
//     }
//

mymacro!(3, "Scotty", fn func());

assert_eq!(func(), "$ Scotty, 3 to beam up");
```