Enum Doc 

pub enum Doc {
    Nil,
    Text(String),
    Line,
    SoftLine,
    HardLine,
    Indent(Box<Doc>),
    Concat(Box<Doc>, Box<Doc>),
    Group(Box<Doc>),
    IfBreak {
        flat: Box<Doc>,
        broken: Box<Doc>,
    },
}

Intermediate representation for formatting.

A Doc describes how content should be laid out, with the actual line-breaking decisions deferred to the printer.

Variants

Nil

Empty document

Text(String)

Literal text (no line breaks allowed within)

Line

A line break: becomes a single space if the enclosing group fits on one line, otherwise becomes a newline followed by current indentation.

SoftLine

A soft line break: becomes empty if the enclosing group fits on one line, otherwise becomes a newline followed by current indentation.

HardLine

Always a line break, regardless of whether the group fits.

Indent(Box<Doc>)

Increase indentation for the nested document.

Concat(Box<Doc>, Box<Doc>)

Concatenate two documents.

Group(Box<Doc>)

Try to fit the document on one line. If it doesn’t fit within the max width, break at Line and SoftLine positions.

IfBreak

Conditional content based on whether the enclosing group breaks.

• flat: used when the group fits on one line
• broken: used when the group breaks across lines

Fields

flat: Box<Doc>

broken: Box<Doc>

Implementations

impl Doc

pub fn text(s: impl Into<String>) -> Doc

Create a text document.

pub fn line() -> Doc

Create a line break (space when flat, newline when broken).

pub fn softline() -> Doc

Create a soft line break (empty when flat, newline when broken).

pub fn hardline() -> Doc

Create a hard line break (always a newline).

pub fn indent(doc: Doc) -> Doc

Indent the given document.

pub fn group(doc: Doc) -> Doc

Create a group that tries to fit on one line.

pub fn concat(self, other: Doc) -> Doc

Concatenate two documents.

pub fn if_break(flat: Doc, broken: Doc) -> Doc

Conditional content based on break state.

pub fn join(docs: impl IntoIterator<Item = Doc>, sep: Doc) -> Doc

Join multiple documents with a separator.

pub fn concat_all(docs: impl IntoIterator<Item = Doc>) -> Doc

Concatenate multiple documents.

pub fn surround(prefix: Doc, content: Doc, suffix: Doc) -> Doc

Wrap content with prefix and suffix.

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl Eq for Doc

impl PartialEq for Doc

fn eq(&self, other: &Doc) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Doc