Enum 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>)

Implementations

impl<'a, D, A> BuildDoc<'a, D, A>

where D: DocPtr<'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, 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

impl<'a, T, A> BuildDoc<'a, T, A>

where T: StaticDoc<'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.

Methods from Deref<Target = Doc<'a, D, 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, D, A: Clone> Clone for BuildDoc<'a, D, A>

where D: DocPtr<'a, A> + Clone,

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> Default for BuildDoc<'a, D, A>

where D: DocPtr<'a, A>,

fn default() -> Self

Returns the “default value” for a type.

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, T, A> From<&'a String> for BuildDoc<'a, T, A>

where T: StaticDoc<'a, A>,

fn from(s: &'a String) -> Self

Converts to this type from the input type.

impl<'a, T, A> From<&'a str> for BuildDoc<'a, T, A>

where T: StaticDoc<'a, A>,

fn from(s: &'a str) -> Self

Converts to this type from the input type.

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, 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

Converts to this type from the input type.

impl<'a, D, A> From<DocBuilder<'a, D, A>> for BuildDoc<'a, D::Doc, A>

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

fn from(val: DocBuilder<'a, D, A>) -> Self

Converts to this type from the input type.

impl<'a, T, A, S> From<Option<S>> for BuildDoc<'a, T, A>

where T: DocPtr<'a, A>, S: Into<BuildDoc<'a, T, A>>,

fn from(s: Option<S>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a, T, A> From<String> for BuildDoc<'a, T, A>

where T: StaticDoc<'a, A>,

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a, D, A> Pretty<'a, D, A> for BuildDoc<'a, D::Doc, A>

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

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

Converts self into a document