Indented Documents (indoc)

Build Status Latest Version

This crate provides a Rust compiler plugin for indented string literals. The indoc!() macro takes a multiline string literal and un-indents it so the leftmost non-space character is in the first column.

Installation

Indoc is available on crates.io. Use the following in Cargo.toml:

toml [dependencies] indoc = "^0.1"

Release notes are available under GitHub releases.

Using Indoc

```rust

![plugin(indoc)]

fn main() { let testing = indoc!(" a b c d"); let expected = "a\n b\nc\n d"; assert_eq!(testing, expected); } ```

Indoc also works with raw string literals:

```rust

![plugin(indoc)]

fn main() { let testing = indoc!(r#" a "b" c d "#); let expected = "a\n \"b\"\nc\n d\n"; assert_eq!(testing, expected); } ```

And byte string literals:

```rust

![plugin(indoc)]

fn main() { let testing = indoc!(b" a b c d "); let expected = b"a\n b\nc\n d\n"; assert_eq!(testing, expected); } ```

Explanation

The following rules characterize the behavior of the indoc!() macro:

  1. Count the leading spaces of each line, ignoring the first line and any lines that are empty or contain spaces only.
  2. Take the minimum.
  3. If the first line is empty i.e. the string begins with a newline, remove the first line.
  4. Remove the computed number of spaces from the beginning of each line.

This means there are a few equivalent ways to format the same string, so choose one you like. All of the following result in the string "line one\nline two\n":

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

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Indoc by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.