Struct pretty::Arena

pub struct Arena<'a, A = ()> { /* private fields */ }

An arena which can be used to allocate Doc values.

Implementations

impl<'a, A> Arena<'a, A>

pub fn new() -> Self

Trait Implementations

impl<A> Default for Arena<'_, A>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, A> DocAllocator<'a, A> for Arena<'a, A>

type Doc = RefDoc<'a, A>

fn alloc(&'a self, doc: Doc<'a, Self::Doc, A>) -> Self::Doc

fn alloc_column_fn(
    &'a self,
    f: impl Fn(usize) -> Self::Doc + 'a
) -> <Self::Doc as DocPtr<'a, A>>::ColumnFn

fn alloc_width_fn(
    &'a self,
    f: impl Fn(isize) -> Self::Doc + 'a
) -> <Self::Doc as DocPtr<'a, A>>::WidthFn

fn alloc_cow(&'a self, doc: BuildDoc<'a, Self::Doc, A>) -> Self::Doc

fn nil(&'a self) -> DocBuilder<'a, Self, A>

Allocate an empty document.

fn fail(&'a self) -> DocBuilder<'a, Self, A>

Fails document rendering immediately.

fn hardline(&'a self) -> DocBuilder<'a, Self, A>

Allocate a single hardline.

fn space(&'a self) -> DocBuilder<'a, Self, A>

fn line(&'a self) -> DocBuilder<'a, Self, A>

A line acts like a \n but behaves like space if it is grouped on a single line.

fn line_(&'a self) -> DocBuilder<'a, Self, A>

Acts like line but behaves like nil if grouped on a single line

fn softline(&'a self) -> DocBuilder<'a, Self, A>

A softline acts like space if the document fits the page, otherwise like line

fn softline_(&'a self) -> DocBuilder<'a, Self, A>

A softline_ acts like nil if the document fits the page, otherwise like line_

fn as_string<U: Display>(&'a self, data: U) -> DocBuilder<'a, Self, A>

Allocate a document containing the text t.to_string().

fn text<U: Into<Cow<'a, str>>>(&'a self, data: U) -> DocBuilder<'a, Self, A>

Allocate a document containing the given text.

fn concat<I>(&'a self, docs: I) -> DocBuilder<'a, Self, A> where
    I: IntoIterator,
    I::Item: Pretty<'a, Self, A>, 

Allocate a document concatenating the given documents.

fn intersperse<I, S>(&'a self, docs: I, separator: S) -> DocBuilder<'a, Self, A> where
    I: IntoIterator,
    I::Item: Pretty<'a, Self, A>,
    S: Pretty<'a, Self, A> + Clone, 

Allocate a document that intersperses the given separator S between the given documents [A, B, C, ..., Z], yielding [A, S, B, S, C, S, ..., S, Z].

fn column(
    &'a self,
    f: impl Fn(usize) -> Self::Doc + 'a
) -> DocBuilder<'a, Self, A>

Allocate a document that acts differently based on the position and page layout

fn nesting(
    &'a self,
    f: impl Fn(usize) -> Self::Doc + 'a
) -> DocBuilder<'a, Self, A>

Allocate a document that acts differently based on the current nesting level

fn reflow(&'a self, text: &'a str) -> DocBuilder<'a, Self, A> where
    Self: Sized,
    Self::Doc: Clone,
    A: Clone, 

Reflows text inserting softline in place of any whitespace

impl<'a, A> Pretty<'a, Arena<'a, A>, A> for RefDoc<'a, A> where
    A: 'a, 

fn pretty(self, allocator: &'a Arena<'a, A>) -> DocBuilder<'a, Arena<'a, A>, A>

Converts self into a document