Struct RefDoc

pub struct RefDoc<'a, A = ()>(pub &'a Doc<'a, RefDoc<'a, A>, A>);

Newtype wrapper for &Doc

Tuple Fields

0: &'a Doc<'a, RefDoc<'a, A>, A>

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where A: Debug,

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

Formats the value using the given formatter.

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

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

The resulting type after dereferencing.

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

Dereferences the value.

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

type ColumnFn = &'a dyn Fn(usize) -> RefDoc<'a, A>

type WidthFn = &'a dyn Fn(isize) -> RefDoc<'a, A>

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

impl<A> Copy for RefDoc<'_, A>