Struct BoxDoc

pub struct BoxDoc<'a, A = ()>(/* private fields */);

Implementations

impl<'a, A> BoxDoc<'a, A>

pub fn new(doc: Doc<'a, BoxDoc<'a, A>, A>) -> BoxDoc<'a, A>

impl<'a, A> BoxDoc<'a, A>

pub fn nil() -> Self

An empty document.

pub fn hardline() -> Self

A single hardline.

pub fn space() -> Self

pub fn fail() -> Self

impl<'a, A> BoxDoc<'a, A>

pub fn line() -> Self

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

pub fn line_() -> Self

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

impl<'a, A> BoxDoc<'a, A>

pub fn as_string<U: Display>(data: U) -> Self

The text t.to_string().

The given text must not contain line breaks.

pub fn text<U: Into<Cow<'a, str>>>(data: U) -> Self

The given text, which must not contain line breaks.

pub fn append<D>(self, that: D) -> Self

where D: Pretty<'a, BoxAllocator, A>,

Append the given document after this document.

pub fn concat<I>(docs: I) -> Self

where I: IntoIterator, I::Item: Pretty<'a, BoxAllocator, A>,

A single document concatenating all the given documents.

pub fn intersperse<I, S>(docs: I, separator: S) -> Self

where I: IntoIterator, I::Item: Pretty<'a, BoxAllocator, A>, S: Pretty<'a, BoxAllocator, A> + Clone, A: Clone,

A single document interspersing the given separator S between the given documents. For example, if the documents are [A, B, C, ..., Z], this yields [A, S, B, S, C, S, ..., S, Z].

Compare the intersperse method from the itertools crate.

NOTE: The separator type, S may need to be cloned. Consider using cheaply cloneable ptr like RefDoc or RcDoc

pub fn flat_alt<D>(self, doc: D) -> Self

where D: Pretty<'a, BoxAllocator, A>,

Acts as self when laid out on multiple lines and acts as that when laid out on a single line.

pub fn group(self) -> Self

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: isize) -> Self

Increase the indentation level of this document.

pub fn annotate(self, ann: A) -> Self

pub fn union<D>(self, other: D) -> Self

where D: Into<BuildDoc<'a, Self, A>>,

pub fn softline() -> Self

pub fn softline_() -> Self

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

pub fn column(f: impl Fn(usize) -> Self + 'static) -> Self

pub fn nesting(f: impl Fn(usize) -> Self + 'static) -> Self

Methods from Deref<Target = Doc<'a, BoxDoc<'a, A>, A>>

pub fn render<W>(&self, width: usize, out: &mut W) -> Result<()>

where W: ?Sized + Write,

Writes a rendered document to a std::io::Write object.

pub fn render_fmt<W>(&self, width: usize, out: &mut W) -> Result

where W: ?Sized + Write,

Writes a rendered document to a std::fmt::Write object.

pub fn render_raw<W>(&self, width: usize, out: &mut W) -> Result<(), W::Error>

where for<'b> W: RenderAnnotated<'b, A> + ?Sized,

Writes a rendered document to a RenderAnnotated<A> object.

pub fn pretty<'d>(&'d self, width: usize) -> PrettyFmt<'a, 'd, T, A>

Returns a value which implements std::fmt::Display

use pretty::{Doc, BoxDoc};
let doc = BoxDoc::<()>::group(
    BoxDoc::text("hello").append(Doc::line()).append(Doc::text("world"))
);
assert_eq!(format!("{}", doc.pretty(80)), "hello world");

Trait Implementations

impl<'a, A: Clone> Clone for BoxDoc<'a, A>

fn clone(&self) -> BoxDoc<'a, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, A> Debug for BoxDoc<'a, A>

where A: Debug,

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

Formats the value using the given formatter.

impl<'a, A> Deref for BoxDoc<'a, A>

type Target = Doc<'a, BoxDoc<'a, A>, A>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, A> DocPtr<'a, A> for BoxDoc<'a, A>

type ColumnFn = Rc<dyn Fn(usize) -> BoxDoc<'a, A> + 'a>

type WidthFn = Rc<dyn Fn(isize) -> BoxDoc<'a, A> + 'a>

impl<'a, A> From<BoxDoc<'a, A>> for BuildDoc<'a, BoxDoc<'a, A>, A>

fn from(s: BoxDoc<'a, A>) -> Self

Converts to this type from the input type.

impl<'a, A> From<Doc<'a, BoxDoc<'a, A>, A>> for BoxDoc<'a, A>

fn from(doc: Doc<'a, BoxDoc<'a, A>, A>) -> BoxDoc<'a, A>

Converts to this type from the input type.

impl<'a, A> Pretty<'a, BoxAllocator, A> for BoxDoc<'a, A>

where A: 'a,

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

Converts self into a document

impl<'a, A> StaticDoc<'a, A> for BoxDoc<'a, A>

const ALLOCATOR: &'static Self::Allocator = _

type Allocator = BoxAllocator