Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dtolnay/indoc
Indented document literals for Rust
https://github.com/dtolnay/indoc
plugin rust
Last synced: about 10 hours ago
JSON representation
Indented document literals for Rust
- Host: GitHub
- URL: https://github.com/dtolnay/indoc
- Owner: dtolnay
- License: apache-2.0
- Created: 2016-03-19T07:01:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T15:47:15.000Z (25 days ago)
- Last Synced: 2024-11-08T20:02:26.293Z (5 days ago)
- Topics: plugin, rust
- Language: Rust
- Homepage:
- Size: 436 KB
- Stars: 665
- Watchers: 4
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
Indented Documents (indoc)
==========================
[
](https://github.com/dtolnay/indoc)
[
](https://crates.io/crates/indoc)
[
](https://docs.rs/indoc)
[
](https://github.com/dtolnay/indoc/actions?query=branch%3Amaster)
This crate provides a procedural macro for indented string literals. The
`indoc!()` macro takes a multiline string literal and un-indents it at compile
time so the leftmost non-space character is in the first column.
```toml
[dependencies]
indoc = "2"
```
*Compiler requirement: rustc 1.56 or greater.*
## Using indoc
```rust
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 also works with raw string literals:
```rust
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);
}
```
And byte string literals:
```rust
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[..]);
}
```
## Formatting macros
The indoc crate exports five additional macros to substitute conveniently for
the standard library's formatting macros:
- `formatdoc!($fmt, ...)` — equivalent to `format!(indoc!($fmt), ...)`
- `printdoc!($fmt, ...)` — equivalent to `print!(indoc!($fmt), ...)`
- `eprintdoc!($fmt, ...)` — equivalent to `eprint!(indoc!($fmt), ...)`
- `writedoc!($dest, $fmt, ...)` — equivalent to `write!($dest, indoc!($fmt), ...)`
- `concatdoc!(...)` — equivalent to `concat!(...)` with each string literal wrapped in `indoc!`
```rust
use indoc::{concatdoc, printdoc};
const HELP: &str = concatdoc! {"
Usage: ", env!("CARGO_BIN_NAME"), " [options]
Options:
-h, --help
"};
fn main() {
printdoc! {"
GET {url}
Accept: {mime}
",
url = "http://localhost:8080",
mime = "application/json",
}
}
```
## 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.
## Unindent
Indoc's indentation logic is available in the `unindent` crate. This may be
useful for processing strings that are not statically known at compile time.
The crate exposes two functions:
- `unindent(&str) -> String`
- `unindent_bytes(&[u8]) -> Vec`
```rust
use unindent::unindent;
fn main() {
let indented = "
line one
line two";
assert_eq!("line one\nline two", unindent(indented));
}
```
#### License
Licensed under either of Apache License, Version
2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.