Struct Document 

pub struct Document { /* private fields */ }

One pretty-printed document: the owner of its layout options, its content, and its rendering.

Configure the layout with the builder methods (before anything is printed), write content through printer, and render by consuming the document with finish — rendering happens exactly once, at the end. The PrettyPrinter this hands out is write-only, so code that is given a printer (a PrettyPrintable implementation, a PrintableGenerator) can never render or otherwise observe the document it is contributing to.

Example

use hegel::Document;

let mut doc = Document::new().max_width(10);
let p = doc.printer();
p.begin_group(1, "[");
p.text("first");
p.text(",");
p.breakable(" ");
p.text("second");
p.end_group("]");
assert_eq!(doc.finish(), "[first,\n second]");

Implementations

impl Document

pub fn new() -> Self

Create an empty document with the default layout options (a maximum line width of 79 characters).

pub fn max_width(self, max_width: usize) -> Self

Keep lines within max_width characters where the group structure allows it. Defaults to 79.

Layout options describe the whole document, so they must be chosen up front: calling this after printer has been used is an error, as is a max_width of 0.

pub fn printer(&mut self) -> &mut PrettyPrinter

The printer to write this document’s content through.

pub fn finish(self) -> String

Splice any outstanding deferred content into place, lay the document out, and return it.

Consuming the document is what makes rendering a once-at-the-end operation; there is no way to observe a partially built document.

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.