Enum pretty::BuildDoc

pub enum BuildDoc<'a, D, A> where
    D: DocPtr<'a, A>,  {
    DocPtr(D),
    Doc(Doc<'a, D, A>),
}

Either a Doc or a pointer to a Doc (D)

Variants

DocPtr(D)

Doc(Doc<'a, D, A>)

Methods

impl<'a, D, A> BuildDoc<'a, D, A> where
    D: DocPtr<'a, A>, 

pub fn nil() -> Self

An empty document.

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

The text t.to_string().

The given text must not contain line breaks.

pub fn hardline() -> Self

A single hardline.

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

The given text, which must not contain line breaks.

pub fn space() -> Self

pub fn fail() -> Self

impl<'a, D, A> BuildDoc<'a, D, A> where
    D: StaticDoc<'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

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

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

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

pub fn render_fmt<W: ?Sized>(&self, width: usize, out: &mut W) -> Result where
    W: 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
    W: RenderAnnotated<'b, A>,
    W: ?Sized, 

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

pub fn pretty<'d>(&'d self, width: usize) -> Pretty<'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");

pub fn render_colored<W>(&self, width: usize, out: W) -> Result<()> where
    W: WriteColor, 

Trait Implementations

impl<'a, D: Clone, A: Clone> Clone for BuildDoc<'a, D, A> where
    D: DocPtr<'a, A>, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, D, A> Debug for BuildDoc<'a, D, A> where
    D: DocPtr<'a, A> + Debug,
    A: Debug, 

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

Formats the value using the given formatter.

impl<'a, D, A> Deref for BuildDoc<'a, D, A> where
    D: DocPtr<'a, A>, 

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

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Performs the conversion.

impl<'a, T, A> From<Doc<'a, T, A>> for BuildDoc<'a, T, A> where
    T: DocPtr<'a, A>, 

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a, T, A, S> From<S> for BuildDoc<'a, T, A> where
    T: DocPtr<'a, A>,
    S: Into<Cow<'a, str>>, 

fn from(s: S) -> Self

Performs the conversion.

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

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

Performs the conversion.