Enum Document 

pub enum Document {
    Empty,
    Newline,
    Char(char, u32),
    Text(Cow<'static, str>, u32),
    Flatten(Rc<Document>),
    Indent(u32, Rc<Document>),
    Concat(Rc<Document>, Rc<Document>),
    Choice(Rc<Document>, Rc<Document>),
}

Variants

Empty

An empty document, rendered as an empty string

Newline

A line break, rendered as a single ‘\n’ char

Char(char, u32)

A single unicode character.

NOTE: Certain char values are normalized to other Document variants, e.g. \n becomes a Document::Newline, not a Document::Char.

Text(Cow<'static, str>, u32)

A literal text string of width n

Flatten(Rc<Document>)

A combinator which chooses the leftmost of each choice in the given document

Indent(u32, Rc<Document>)

Increase the indentation of the given document by n

Concat(Rc<Document>, Rc<Document>)

Concatenate two documents

Choice(Rc<Document>, Rc<Document>)

Choose the more optimal of two documents depending on the amount of space remaining in the layout

Implementations

impl Document

pub fn is_empty(&self) -> bool

Returns true if this document has no content, i.e. Document::Empty

pub fn has_leading_newline(&self) -> bool

Returns true if the content of this document starts with a line break.

This is primarily intended for use by the pretty printer itself, but may be useful to others.

Trait Implementations

impl Add for Document

fn add(self, other: Document) -> <Document as Add>::Output

Concatenate the two documents

type Output = Document

The resulting type after applying the + operator.

impl Add<&'static str> for Document

fn add(self, other: &'static str) -> <Document as Add<&'static str>>::Output

Concatenate the two documents

type Output = Document

The resulting type after applying the + operator.

impl Add<Document> for &'static str

fn add(self, other: Document) -> <&'static str as Add<Document>>::Output

Concatenate the two documents

type Output = Document

The resulting type after applying the + operator.

impl Add<char> for Document

fn add(self, other: char) -> <Document as Add<char>>::Output

Concatenate the two documents

type Output = Document

The resulting type after applying the + operator.

impl AddAssign for Document

fn add_assign(&mut self, rhs: Document)

Append rhs to self

impl AddAssign<&'static str> for Document

fn add_assign(&mut self, rhs: &'static str)

Append rhs to self

impl AddAssign<char> for Document

fn add_assign(&mut self, rhs: char)

Append rhs to self

impl BitOr for Document

fn bitor(self, other: Document) -> <Document as BitOr>::Output

If inside a flat, or the first line of the left document fits within the required width, then display the left document. Otherwise, display the right document.

type Output = Document

The resulting type after applying the | operator.

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl Display for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&'static str> for Document

fn from(s: &'static str) -> Document

Converts to this type from the input type.

impl From<String> for Document

fn from(s: String) -> Document

Converts to this type from the input type.

impl From<char> for Document

fn from(c: char) -> Document

Converts to this type from the input type.