Enum pretty::Doc

pub enum Doc<'a, B> {
    Nil,
    Append(B, B),
    Group(B),
    Nest(usize, B),
    Space,
    Newline,
    Text(Cow<'a, str>),
}

The concrete document type. This type is not meant to be used directly. Instead use the static functions on Doc or the methods on an DocAllocator.

The B parameter is used to abstract over pointers to Doc. See RefDoc and BoxDoc for how it is used

Variants

NilAppend(B, B)Group(B)Nest(usize, B)SpaceNewlineText(Cow<'a, str>)

Methods

impl<'a, B> Doc<'a, B>

pub fn render<'b, W: ?Sized + Write>(
    &'b self,
    width: usize,
    out: &mut W
) -> Result<()> where
    B: Deref<Target = Doc<'b, B>>, 

Writes a rendered document.

impl<'a, B> Doc<'a, B>

pub fn nil() -> Doc<'a, B>

pub fn as_string<T: ToString>(t: T) -> Doc<'a, B>

pub fn newline() -> Doc<'a, B>

pub fn text<T: Into<Cow<'a, str>>>(data: T) -> Doc<'a, B>

pub fn space() -> Doc<'a, B>

impl<'a> Doc<'a, BoxDoc<'a>>

pub fn append(self, that: Doc<'a, BoxDoc<'a>>) -> Doc<'a, BoxDoc<'a>>

pub fn concat<I>(&'a self, docs: I) -> Doc<'a, BoxDoc<'a>> where
    I: IntoIterator<Item = Doc<'a, BoxDoc<'a>>>, 

pub fn group(self) -> Doc<'a, BoxDoc<'a>>

pub fn nest(self, offset: usize) -> Doc<'a, BoxDoc<'a>>

Trait Implementations

impl<'a, B: Clone> Clone for Doc<'a, B>

fn clone(&self) -> Doc<'a, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, B: Debug> Debug for Doc<'a, B>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, B: Eq> Eq for Doc<'a, B>

impl<'a, B: Ord> Ord for Doc<'a, B>

fn cmp(&self, __arg_0: &Doc<'a, B>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<'a, B: PartialEq> PartialEq for Doc<'a, B>

fn eq(&self, __arg_0: &Doc<'a, B>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Doc<'a, B>) -> bool

This method tests for !=.

impl<'a, B: PartialOrd> PartialOrd for Doc<'a, B>

fn partial_cmp(&self, __arg_0: &Doc<'a, B>) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Doc<'a, B>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Doc<'a, B>) -> bool

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

fn gt(&self, __arg_0: &Doc<'a, B>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Doc<'a, B>) -> bool

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

impl<'a, B, S> From<S> for Doc<'a, B> where
    S: Into<Cow<'a, str>>, 

fn from(s: S) -> Doc<'a, B>

Performs the conversion.

impl<'a, A: ?Sized> Into<Doc<'a, A::Doc>> for DocBuilder<'a, A> where
    A: DocAllocator<'a>, 

fn into(self) -> Doc<'a, A::Doc>

Performs the conversion.