Enum pretty::Doc

pub enum Doc<'a, A, B> {
    Nil,
    Append(B, B),
    Group(B),
    Nest(usize, B),
    Space,
    Newline,
    Text(Cow<'a, str>),
    Annotated(A, B),
}

The concrete document type. This type is not meant to be used directly. Instead use the static functions on Doc or the methods on an DocAllocator.

The B parameter is used to abstract over pointers to Doc. See RefDoc and BoxDoc for how it is used

Variants

NilAppend(B, B)Group(B)Nest(usize, B)SpaceNewlineText(Cow<'a, str>)Annotated(A, B)

Methods

impl<'a, A, B> Doc<'a, A, B>

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

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

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

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

pub fn pretty<'b>(&'b self, width: usize) -> Pretty<'b, A, B> where
    B: Deref<Target = Doc<'b, A, 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");

impl<'a, B> Doc<'a, ColorSpec, B>

pub fn render_colored<'b, W>(&'b self, width: usize, out: W) -> Result<()> where
    B: Deref<Target = Doc<'b, ColorSpec, B>>,
    W: WriteColor, 

impl<'a, A, B> Doc<'a, A, B>

pub fn nil() -> Doc<'a, A, B>

An empty document.

pub fn as_string<T: ToString>(t: T) -> Doc<'a, A, B>

The text t.to_string().

The given text must not contain line breaks.

pub fn newline() -> Doc<'a, A, B>

A single newline.

pub fn text<T: Into<Cow<'a, str>>>(data: T) -> Doc<'a, A, B>

The given text, which must not contain line breaks.

pub fn space() -> Doc<'a, A, B>

A space.

impl<'a, A> Doc<'a, A, BoxDoc<'a, A>>

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

Append the given document after this document.

pub fn concat<I>(docs: I) -> Doc<'a, A, BoxDoc<'a, A>> where
    I: IntoIterator<Item = Doc<'a, A, BoxDoc<'a, A>>>, 

A single document concatenating all the given documents.

pub fn intersperse<I, S>(docs: I, separator: S) -> Doc<'a, A, BoxDoc<'a, A>> where
    I: IntoIterator<Item = Doc<'a, A, BoxDoc<'a, A>>>,
    S: Into<Doc<'a, A, BoxDoc<'a, A>>> + Clone,
    A: Clone, 

A single document interspersing the given separator S between the given documents. For example, if the documents are [A, B, C, ..., Z], this yields [A, S, B, S, C, S, ..., S, Z].

Compare the intersperse method from the itertools crate.

pub fn group(self) -> Doc<'a, A, BoxDoc<'a, 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.

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

Increase the indentation level of this document.

pub fn annotate(self, ann: A) -> Doc<'a, A, BoxDoc<'a, A>>

Trait Implementations

impl<'a, A: Clone, B: Clone> Clone for Doc<'a, A, B>

fn clone(&self) -> Doc<'a, A, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, A: Debug, B: Debug> Debug for Doc<'a, A, B>

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

Formats the value using the given formatter.

impl<'a, A: Eq, B: Eq> Eq for Doc<'a, A, B>

impl<'a, A: Ord, B: Ord> Ord for Doc<'a, A, B>

fn cmp(&self, __arg_0: &Doc<'a, A, B>) -> 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, A: PartialEq, B: PartialEq> PartialEq for Doc<'a, A, B>

fn eq(&self, __arg_0: &Doc<'a, A, B>) -> bool

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

fn ne(&self, __arg_0: &Doc<'a, A, B>) -> bool

This method tests for !=.

impl<'a, A: PartialOrd, B: PartialOrd> PartialOrd for Doc<'a, A, B>

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

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

fn lt(&self, __arg_0: &Doc<'a, A, B>) -> bool

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

fn le(&self, __arg_0: &Doc<'a, A, B>) -> bool

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

fn gt(&self, __arg_0: &Doc<'a, A, B>) -> bool

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

fn ge(&self, __arg_0: &Doc<'a, A, B>) -> bool

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

impl<'a, A, B, S> From<S> for Doc<'a, A, B> where
    S: Into<Cow<'a, str>>, 

fn from(s: S) -> Doc<'a, A, B>

Performs the conversion.

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

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

Performs the conversion.