unindent 0.1.11

Remove a column of leading whitespace from a string


This crate provides indoc's indentation logic for use with strings that are not statically known at compile time. For unindenting string literals, use indoc instead.

This crate exposes two functions:

  • 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));


The following rules characterize the behavior of unindent:

  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":

unindent("          /      unindent(           /      unindent("line one
   line one        /         "line one        /                 line two
   line two       /           line two       /                  ")
   ")            /            ")            /


Licensed under either of

at your option.


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.