Skip to main content

Doc

Enum Doc 

Source
pub enum Doc {
    Nil,
    Text(String),
    Line,
    HardLine,
    Concat(Vec<Doc>),
    Nest(i32, Box<Doc>),
    Group(Box<Doc>),
}
Expand description

Wadler-Lindig pretty-printing combinators.

A Doc describes a document that can be rendered at a given line width. Group(d) attempts to render d on a single line; if it doesn’t fit within the remaining width the group “breaks” and any Line inside becomes a newline followed by the current indentation.

Variants§

§

Nil

§

Text(String)

§

Line

Soft line: a space when the enclosing group is flat, a newline + indentation when it is broken.

§

HardLine

Hard line: always a newline + indentation regardless of group mode.

§

Concat(Vec<Doc>)

§

Nest(i32, Box<Doc>)

Increase indentation for the inner document by n spaces.

§

Group(Box<Doc>)

Try to render the inner document flat; break if it exceeds the width.

Implementations§

Source§

impl Doc

Source

pub fn nil() -> Self

Source

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

Source

pub fn concat(docs: Vec<Doc>) -> Self

Source

pub fn nest(indent: i32, doc: Doc) -> Self

Source

pub fn group(doc: Doc) -> Self

Trait Implementations§

Source§

impl Clone for Doc

Source§

fn clone(&self) -> Doc

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Doc

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Doc

§

impl RefUnwindSafe for Doc

§

impl Send for Doc

§

impl Sync for Doc

§

impl Unpin for Doc

§

impl UnsafeUnpin for Doc

§

impl UnwindSafe for Doc

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.