Struct pretty::RefDoc

pub struct RefDoc<'a>(_);

Newtype wrapper for &doc::Doc

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

fn render<'b, W: ?Sized>(&'b self, width: usize, out: &mut W) -> Result<()> where
    B: Deref<Target = Doc<'b, B>>,
    W: Write, 

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

fn render_fmt<'b, W: ?Sized>(&'b self, width: usize, out: &mut W) -> Result where
    B: Deref<Target = Doc<'b, B>>,
    W: Write, 

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

fn pretty<'b>(&'b self, width: usize) -> Pretty<'b, B> where
    B: Deref<Target = Doc<'b, B>>, 

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");

fn append(self, that: Doc<'a, BoxDoc<'a>>) -> Doc<'a, BoxDoc<'a>>

Append the given document after this document.

fn group(self) -> Doc<'a, BoxDoc<'a>>

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.

fn nest(self, offset: usize) -> Doc<'a, BoxDoc<'a>>

Increase the indentation level of this document.

Trait Implementations

impl<'a> Clone for RefDoc<'a>

fn clone(&self) -> RefDoc<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Eq for RefDoc<'a>

impl<'a> Ord for RefDoc<'a>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<'a> PartialEq for RefDoc<'a>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &RefDoc<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd for RefDoc<'a>

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

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

fn lt(&self, __arg_0: &RefDoc<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &RefDoc<'a>) -> bool

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

fn gt(&self, __arg_0: &RefDoc<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &RefDoc<'a>) -> bool

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

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

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

Formats the value using the given formatter.

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

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

The resulting type after dereferencing.

fn deref(&self) -> &Doc<'a, RefDoc<'a>>

Dereferences the value.