Struct DocumentView 

pub struct DocumentView { /* private fields */ }

A parsed document, ready to print. Build one from source with org, asciidoc or man, or from a Document built by hand with new.

use rich::Console;
use rich_ext::document::DocumentView;

let console = Console::builder().width(40).color_system(None).build();
let view = DocumentView::org("* TODO Write the report :work:\nSome /italic/ text.");
let out = console.render_to_string(&view);
assert!(out.contains("TODO Write the report"));
assert!(out.contains("Some italic text."));

Implementations

impl DocumentView

pub fn new(document: Document) -> Self

Draw document with the default RenderOptions.

pub fn from_parsed(parsed: Parsed) -> Self

Draw what a parser returned, keeping its diagnostics.

pub fn org(source: &str) -> Self

Parse and draw an Org document.

pub fn asciidoc(source: &str) -> Self

Parse and draw an AsciiDoc document.

pub fn man(source: &str) -> Self

Parse and draw a man page (man or mdoc macros).

pub fn options(self, options: RenderOptions) -> Self

Replace every render option.

pub fn hyperlinks(self, hyperlinks: bool) -> Self

Whether links carry OSC 8 hyperlinks (see RenderOptions::hyperlinks).

pub fn code_theme(self, theme: impl Into<String>) -> Self

The Syntax theme for code blocks.

pub fn default_language(self, language: impl Into<String>) -> Self

The language of code blocks that name none.

pub fn fence_renderer(self, renderer: Arc<dyn FenceRenderer>) -> Self

Ask renderer first for code blocks with a language.

pub fn document(&self) -> &Document

The parsed document.

pub fn diagnostics(&self) -> &[Diagnostic]

What the parser could not show as written.

pub fn render_options(&self) -> &RenderOptions

The render options.

Trait Implementations

impl Clone for DocumentView

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 DocumentView

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

Formats the value using the given formatter.

impl Renderable for DocumentView

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, _console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.