Struct DocBuilder

pub struct DocBuilder<'a, D, A = ()>(pub &'a D, pub Doc<'a, D::Doc, A>)
where
    D: ?Sized + DocAllocator<'a, A> + 'a;

The DocBuilder type allows for convenient appending of documents even for arena allocated documents by storing the arena inline.

Tuple Fields

0: &'a D

1: Doc<'a, D::Doc, A>

Implementations

impl<'a, 's, D, A> DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A>,

pub fn append<E>(self, that: E) -> DocBuilder<'a, D, A>

where E: Into<Doc<'a, D::Doc, A>>,

Append the given document after this document.

pub fn group(self) -> DocBuilder<'a, D, A>

Mark this document as a group.

Groups are layed out on a single line if possible. Within a group, all basic documents with several possible layouts are assigned the same layout, that is, they are all layed out horizontally and combined into a one single line, or they are each layed out on their own line.

pub fn nest(self, offset: usize) -> DocBuilder<'a, D, A>

Increase the indentation level of this document.

pub fn annotate(self, ann: A) -> DocBuilder<'a, D, A>

Trait Implementations

impl<'a, A, D> Clone for DocBuilder<'a, D, A>

where A: Clone, D: DocAllocator<'a, A> + 'a, D::Doc: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, D, A> Into<Doc<'a, <D as DocAllocator<'a, A>>::Doc, A>> for DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A>,

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

Converts this type into the (usually inferred) input type.

impl<'a, D, A: Ord> Ord for DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A> + 'a + Ord, D::Doc: Ord,

fn cmp(&self, other: &DocBuilder<'a, D, 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, D, A: PartialEq> PartialEq for DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A> + 'a + PartialEq, D::Doc: PartialEq,

fn eq(&self, other: &DocBuilder<'a, D, 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, D, A: PartialOrd> PartialOrd for DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A> + 'a + PartialOrd, D::Doc: PartialOrd,

fn partial_cmp(&self, other: &DocBuilder<'a, D, 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, D, A: Eq> Eq for DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A> + 'a + Eq, D::Doc: Eq,

impl<'a, D, A> StructuralPartialEq for DocBuilder<'a, D, A>

where D: ?Sized + DocAllocator<'a, A> + 'a,