Struct Document 

pub struct Document { /* private fields */ }

Available on crate feature document only.

An ordered list of blocks that make up a command’s human output.

Every builder method takes self and returns it, so a document reads as one chain. A command’s Present implementation returns one, and a Section nests one as its body.

Implementations

impl Document

pub const fn new() -> Self

Start an empty document.

pub fn block(self, block: impl Into<Block>) -> Self

Append any value that converts into a Block, such as a Fields, Table, Section, Notice, or Rule.

pub fn heading(self, value: impl Into<Text>) -> Self

Append a heading. It is styled with Role::Heading and wraps to the width.

pub fn paragraph(self, value: impl Into<Text>) -> Self

Append prose that wraps to the width. Spans keep their roles.

pub fn verbatim(self, value: impl Into<String>) -> Self

Append preformatted text that is never wrapped or styled.

See Block::Verbatim for the characters the renderer removes.

pub fn fields(self, fields: Fields) -> Self

Append a record of label and value rows.

pub fn table(self, table: Table) -> Self

Append a table. Its frame follows the table frame of the render options.

pub fn section(self, section: Section) -> Self

Append a section: a heading directly over a nested document.

pub fn notice(self, notice: Notice) -> Self

Append a notice: a level label, an optional code, and a message.

pub fn rule(self, title: Option<Text>) -> Self

Append a horizontal rule across the width. A title is drawn in the rule with Role::Heading.

pub fn is_empty(&self) -> bool

Whether the document has no blocks. A document of blocks that draw nothing, such as an empty paragraph, is not empty but renders no lines.

pub fn blocks(&self) -> &[Block]

The blocks, in the order they were appended.

impl Document

pub fn render(&self, options: RenderOptions) -> String

Available on crate feature render only.

Render with explicit semantic options; see RenderOptions.

The string is a pure function of the document and the options: no terminal is asked. The document lays out to the explicit width, else the fallback width, else its natural width.

Styles are written only under ColorMode::Always, as the theme gives them, at full colour depth. ColorMode::Auto has no stream to look at here and writes none. A View and help write to a stream, so they decide width and colour for it instead.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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.

impl Eq for Document

impl PartialEq for Document

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Document