Enum Document 

pub enum Document<'a> {
    String(&'a str),
    Array(Vec<Document<'a>>),
    Indent(Vec<Document<'a>>),
    IndentIfBreak(IndentIfBreak<'a>),
    Group(Group<'a>),
    Line(Line),
    LineSuffix(Vec<Document<'a>>),
    LineSuffixBoundary,
    IfBreak(IfBreak<'a>),
    Fill(Fill<'a>),
    BreakParent,
    Align(Align<'a>),
    Trim(Trim),
    DoNotTrim,
}

Variants

String(&'a str)

Array(Vec<Document<'a>>)

Indent(Vec<Document<'a>>)

Increase the level of indentation.

IndentIfBreak(IndentIfBreak<'a>)

Group(Group<'a>)

Mark a group of items which the printer should try to fit on one line. This is the basic command to tell the printer when to break. Groups are usually nested, and the printer will try to fit everything on one line, but if it doesn’t fit it will break the outermost group first and try again. It will continue breaking groups until everything fits (or there are no more groups to break).

Line(Line)

Specify a line break. If an expression fits on one line, the line break will be replaced with a space. Line breaks always indent the next line with the current level of indentation.

LineSuffix(Vec<Document<'a>>)

This is used to implement trailing comments. It’s not practical to constantly check where the line ends to avoid accidentally printing some code at the end of a comment. lineSuffix buffers docs passed to it and flushes them before any new line.

LineSuffixBoundary

IfBreak(IfBreak<'a>)

Print something if the current group or the current element of fill breaks and something else if it doesn’t.

Fill(Fill<'a>)

This is an alternative type of group which behaves like text layout: it’s going to add a break whenever the next element doesn’t fit in the line anymore. The difference with group is that it’s not going to break all the separators, just the ones that are at the end of lines.

BreakParent

Include this anywhere to force all parent groups to break.

Align(Align<'a>)

Trim(Trim)

Trim all newlines from the end of the document.

DoNotTrim

Do not perform any trimming before printing the next document.

Implementations

impl<'a> Document<'a>

pub fn empty() -> Document<'a>

pub fn space() -> Document<'a>

pub fn can_break(&self) -> bool

pub fn any<F>(&self, predicate: F) -> bool

where F: Fn(&Document<'a>) -> bool,

pub fn join( documents: Vec<Document<'a>>, separator: Separator, ) -> Vec<Document<'a>>

Trait Implementations

impl<'a> Clone for Document<'a>

fn clone(&self) -> Document<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.

impl Display for Document<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for Document<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Document<'a>

fn cmp(&self, other: &Document<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Document<'a>

fn eq(&self, other: &Document<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for Document<'a>

fn partial_cmp(&self, other: &Document<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for Document<'a>

impl<'a> StructuralPartialEq for Document<'a>