Struct prettify_cmark::PrettyPrinter

pub struct PrettyPrinter<W = String> { /* fields omitted */ }

Event-driven pretty printer for CommonMark documents.

The printer can be driven by pushing events into it, which can be obtained using pulldown_cmark::Parser.

Examples

extern crate pulldown_cmark;
extern crate prettify_cmark;

use pulldown_cmark::Parser;
use prettify_cmark::PrettyPrinter;

fn main() {
    let events = Parser::new("Lorem _ipsum_!\n\nDolor `sit`.");
    let mut printer = PrettyPrinter::new_with_prefix(String::new(), "///");
    printer.push_events(events).unwrap();

    assert_eq!(printer.into_inner(), "/// Lorem *ipsum*!\n///\n/// Dolor `sit`.")
}

Methods

impl<W: Write> PrettyPrinter<W>

fn new(write: W) -> PrettyPrinter<W>

Create a new pretty printer that wraps around a writer.

fn new_with_prefix(write: W, prefix: &str) -> PrettyPrinter<W>

Create a new pretty printer with a prefix that wraps around a writer.

The prefix will be applied to all lines that are produced by the printer.

fn push_event<'a>(&mut self, event: Event<'a>) -> Result

Push a single event into the printer.

Events can be obtained using pulldown_cmark::Parser.

fn push_events<'a, I>(&mut self, events: I) -> Result where
    I: IntoIterator<Item = Event<'a>>, 

Push a series of events into the printer.

Events can be obtained using pulldown_cmark::Parser.

fn into_inner(self) -> W

Unwrap the printer, returning the underlying writer.

Trait Implementations

impl Default for PrettyPrinter

fn default() -> PrettyPrinter

Returns the "default value" for a type.