Struct Arena

pub struct Arena<'a> { /* private fields */ }

An arena which can be used to allocate Doc values.

Implementations

impl<'a> Arena<'a>

pub fn new() -> Arena<'a>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl Default for Arena<'_>

fn default() -> Arena<'_>

Returns the “default value” for a type.

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

fn text<U>(&'a self, data: U) -> DocBuilder<'a, Arena<'a>>

where U: Into<Cow<'a, str>>,

Optimized text allocation for common ASCII characters.

type Doc = RefDoc<'a>

fn alloc( &'a self, doc: Doc<'a, <Arena<'a> as DocAllocator<'a>>::Doc>, ) -> <Arena<'a> as DocAllocator<'a>>::Doc

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

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

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

Allocate an empty document.

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

Fails document rendering immediately.

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

Allocate a single hardline.

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

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>

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

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

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

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

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

fn if_group_flat(&'a self, doc: impl Pretty<'a, Self>) -> DocBuilder<'a, Self>

Equivalent to self.nil().flat_alt(doc.pretty(self))

fn if_group_break(&'a self, doc: impl Pretty<'a, Self>) -> DocBuilder<'a, Self>

Equivalent to doc.pretty(self).flat_alt(self.nil())

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

Make the parent group break

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

where U: Display,

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

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

where U: Into<Cow<'a, str>>,

Allocate a document containing the given text, which is assumed to be ASCII.

fn spaces(&'a self, n: usize) -> DocBuilder<'a, Self>

Allocate a document containing n spaces.

fn line_suffix(&'a self, doc: impl Pretty<'a, Self>) -> DocBuilder<'a, Self>

Pushes some content to the end of the current line.

fn concat<I>(&'a self, docs: I) -> DocBuilder<'a, Self>

where I: IntoIterator, <I as IntoIterator>::Item: Pretty<'a, Self>,

Allocate a document concatenating the given documents.

fn intersperse<I, S>(&'a self, docs: I, separator: S) -> DocBuilder<'a, Self>

where I: IntoIterator, <I as IntoIterator>::Item: Pretty<'a, Self>, S: Pretty<'a, Self> + 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 reflow(&'a self, text: &'a str) -> DocBuilder<'a, Self>

where Self: Sized, Self::Doc: Clone,

Reflows text inserting softline in place of any whitespace