Struct sparkly::Doc

pub struct Doc { /* fields omitted */ }

The type of pretty-printed text.

Methods

impl Doc

fn empty() -> Doc

Returns an empty Doc.

fn line() -> Doc

Expands to a newline, which will never be shortened.

fn line_or(s: &'static str) -> Doc

Expands to the given string, if it will fit, or a newline if it won't.

fn lines<I: IntoIterator<Item = T>, T: Sparkly>(iter: I) -> Doc

Concatenates Docs, putting newlines between them.

fn nbsp() -> Doc

Returns a Doc that always expands to a space.

fn space() -> Doc

Returns a Doc that expands to a space if it will fit, or a newline if it won't.

fn split_point() -> Doc

Returns a Doc that represents a point where a line may be split if needed.

fn text<T: ToString>(t: T, sty: Style) -> Doc

Constructs a Doc containing the given text with the given style.

impl Doc

fn append(self, right: Doc) -> Doc

Appends one Doc to another.

fn bracket(self, l: &'static str, r: &'static str) -> Doc

Brackets a Doc between two constant strings.

fn group(self) -> Doc

Groups the contents of a Doc.

fn join<I: IntoIterator<Item = T>, T: Sparkly>(self, iter: I) -> Doc

Joins Docs, placing the self Doc between them.

fn nest(self, n: usize) -> Doc

Nests the Doc with the given amount of indentation.

fn style(self, style: Style) -> Doc

Applies a style to a Doc.

impl Doc

fn display(&self) -> Display

Returns an object that implements Display for the current size of the terminal, or 80 columns wide if it cannot be detected. Color is enabled if stdout is a TTY.

Terminal width detection requires the termion feature.

fn display_opts(&self, width: usize, color: bool) -> Display

Returns an object that implements Display for the given options.

Trait Implementations

impl From<&'static str> for Doc

fn from(s: &'static str) -> Doc

Performs the conversion.

impl From<String> for Doc

fn from(s: String) -> Doc

Performs the conversion.

impl FromIterator<Doc> for Doc

fn from_iter<T: IntoIterator<Item = Doc>>(iter: T) -> Doc

Creates a value from an iterator.

impl Clone for Doc

fn clone(&self) -> Doc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl PartialEq for Doc

fn eq(&self, __arg_0: &Doc) -> bool

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

fn ne(&self, __arg_0: &Doc) -> bool

This method tests for !=.

impl From<DocInner> for Doc

fn from(inner: DocInner) -> Doc

Performs the conversion.

impl Sparkly for Doc

fn to_doc(&self) -> Doc

Returns a Doc corresponding to the value.