Struct RefDoc

pub struct RefDoc<'a, A: 'a>(/* private fields */);

Newtype wrapper for &Doc

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

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

where T: Deref<Target = Doc<'b, T, A>>, W: ?Sized + Write,

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

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

where T: Deref<Target = Doc<'b, T, A>>, W: ?Sized + Write,

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

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

where T: Deref<Target = Doc<'b, T, A>>, W: ?Sized + RenderAnnotated<A>,

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

pub fn pretty<'b>(&'b self, width: usize) -> Pretty<'b, T, A>

where T: Deref<Target = Doc<'b, T, A>>,

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

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

Trait Implementations

impl<'a, A: Clone + 'a> Clone for RefDoc<'a, A>

fn clone(&self) -> RefDoc<'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 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: Ord + 'a> Ord for RefDoc<'a, A>

fn cmp(&self, other: &RefDoc<'a, A>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, A: PartialEq + 'a> PartialEq for RefDoc<'a, A>

fn eq(&self, other: &RefDoc<'a, A>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, A: PartialOrd + 'a> PartialOrd for RefDoc<'a, A>

fn partial_cmp(&self, other: &RefDoc<'a, A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, A: Eq + 'a> Eq for RefDoc<'a, A>

impl<'a, A: 'a> StructuralPartialEq for RefDoc<'a, A>