Struct Renderer

pub struct Renderer<'writer, 'config> {
    writer: &'writer mut dyn Write,
    config: &'config Config,
}

A renderer of display list entries.

The following diagram gives an overview of each of the parts of the renderer’s output:

                    ┌ outer gutter
                    │ ┌ left border
                    │ │ ┌ inner gutter
                    │ │ │   ┌─────────────────────────── source ─────────────────────────────┐
                    │ │ │   │                                                                │
                 ┌────────────────────────────────────────────────────────────────────────────
       header ── │ error[0001]: oh noes, a cupcake has occurred!
snippet start ── │    ┌─ test:9:0
snippet empty ── │    │
 snippet line ── │  9 │   ╭ Cupcake ipsum dolor. Sit amet marshmallow topping cheesecake
 snippet line ── │ 10 │   │ muffin. Halvah croissant candy canes bonbon candy. Apple pie jelly
                 │    │ ╭─│─────────^
snippet break ── │    · │ │
 snippet line ── │ 33 │ │ │ Muffin danish chocolate soufflé pastry icing bonbon oat cake.
 snippet line ── │ 34 │ │ │ Powder cake jujubes oat cake. Lemon drops tootsie roll marshmallow
                 │    │ │ ╰─────────────────────────────^ blah blah
snippet break ── │    · │
 snippet line ── │ 38 │ │   Brownie lemon drops chocolate jelly-o candy canes. Danish marzipan
 snippet line ── │ 39 │ │   jujubes soufflé carrot cake marshmallow tiramisu caramels candy canes.
                 │    │ │           ^^^^^^^^^^^^^^^^^^^ -------------------- blah blah
                 │    │ │           │
                 │    │ │           blah blah
                 │    │ │           note: this is a note
 snippet line ── │ 40 │ │   Fruitcake jelly-o danish toffee. Tootsie roll pastry cheesecake
 snippet line ── │ 41 │ │   soufflé marzipan. Chocolate bar oat cake jujubes lollipop pastry
 snippet line ── │ 42 │ │   cupcake. Candy canes cupcake toffee gingerbread candy canes muffin
                 │    │ │                                ^^^^^^^^^^^^^^^^^^ blah blah
                 │    │ ╰──────────^ blah blah
snippet break ── │    ·
 snippet line ── │ 82 │     gingerbread toffee chupa chups chupa chups jelly-o cotton candy.
                 │    │                 ^^^^^^                         ------- blah blah
snippet empty ── │    │
 snippet note ── │    = blah blah
 snippet note ── │    = blah blah blah
                 │      blah blah
 snippet note ── │    = blah blah blah
                 │      blah blah
        empty ── │

Filler text from http://www.cupcakeipsum.com

Fields

writer: &'writer mut dyn Write

config: &'config Config

Implementations

impl<'writer, 'config> Renderer<'writer, 'config>

pub fn new( writer: &'writer mut dyn Write, config: &'config Config, ) -> Renderer<'writer, 'config>

Construct a renderer from the given writer and config.

fn chars(&self) -> &'config Chars

pub fn render_header( &mut self, locus: Option<&Locus>, severity: Severity, code: Option<&str>, message: &str, ) -> Result<(), Error>

Diagnostic header, with severity, code, and message.

error[E0001]: unexpected type in `+` application

pub fn render_empty(&mut self) -> Result<(), Error>

Empty line.

pub fn render_snippet_start( &mut self, outer_padding: usize, locus: &Locus, ) -> Result<(), Error>

Top left border and locus.

┌─ test:2:9

pub fn render_snippet_source( &mut self, outer_padding: usize, line_number: usize, source: &str, severity: Severity, single_labels: &[(LabelStyle, Range<usize>, &'_ str)], num_multi_labels: usize, multi_labels: &[(usize, LabelStyle, MultiLabel<'_>)], ) -> Result<(), Error>

A line of source code.

10 │   │ muffin. Halvah croissant candy canes bonbon candy. Apple pie jelly
   │ ╭─│─────────^

pub fn render_snippet_empty( &mut self, outer_padding: usize, severity: Severity, num_multi_labels: usize, multi_labels: &[(usize, LabelStyle, MultiLabel<'_>)], ) -> Result<(), Error>

An empty source line, for providing additional whitespace to source snippets.

│ │ │

pub fn render_snippet_break( &mut self, outer_padding: usize, severity: Severity, num_multi_labels: usize, multi_labels: &[(usize, LabelStyle, MultiLabel<'_>)], ) -> Result<(), Error>

A broken source line, for labeling skipped sections of source.

· │ │

pub fn render_snippet_note( &mut self, outer_padding: usize, message: &str, ) -> Result<(), Error>

Additional notes.

= expected type `Int`
     found type `String`

fn char_metrics( &self, char_indices: impl Iterator<Item = (usize, char)>, ) -> impl Iterator<Item = (Metrics, char)>

Adds tab-stop aware unicode-width computations to an iterator over character indices. Assumes that the character indices begin at the start of the line.

fn snippet_locus(&mut self, locus: &Locus) -> Result<(), Error>

Location focus.

fn outer_gutter(&mut self, outer_padding: usize) -> Result<(), Error>

The outer gutter of a source line.

fn outer_gutter_number( &mut self, line_number: usize, outer_padding: usize, ) -> Result<(), Error>

The outer gutter of a source line, with line number.

fn border_left(&mut self) -> Result<(), Error>

The left-hand border of a source line.

fn border_left_break(&mut self) -> Result<(), Error>

The broken left-hand border of a source line.

fn caret_pointers( &mut self, severity: Severity, max_label_start: usize, single_labels: &[(LabelStyle, Range<usize>, &'_ str)], trailing_label: Option<(usize, &(LabelStyle, Range<usize>, &'_ str))>, char_indices: impl Iterator<Item = (usize, char)>, ) -> Result<(), Error>

Write vertical lines pointing to carets.

fn label_multi_left( &mut self, severity: Severity, label_style: LabelStyle, underline: Option<LabelStyle>, ) -> Result<(), Error>

The left of a multi-line label.

 │

fn label_multi_top_left( &mut self, severity: Severity, label_style: LabelStyle, ) -> Result<(), Error>

The top-left of a multi-line label.

 ╭

fn label_multi_bottom_left( &mut self, severity: Severity, label_style: LabelStyle, ) -> Result<(), Error>

The bottom left of a multi-line label.

 ╰

fn label_multi_top_caret( &mut self, severity: Severity, label_style: LabelStyle, source: &str, start: usize, ) -> Result<(), Error>

Multi-line label top.

─────────────^

fn label_multi_bottom_caret( &mut self, severity: Severity, label_style: LabelStyle, source: &str, start: usize, message: &str, ) -> Result<(), Error>

Multi-line label bottom, with a message.

─────────────^ expected `Int` but found `String`

fn inner_gutter_column( &mut self, severity: Severity, underline: Option<(LabelStyle, VerticalBound)>, ) -> Result<(), Error>

Writes an empty gutter space, or continues an underline horizontally.

fn inner_gutter_space(&mut self) -> Result<(), Error>

Writes an empty gutter space.

fn inner_gutter( &mut self, severity: Severity, num_multi_labels: usize, multi_labels: &[(usize, LabelStyle, MultiLabel<'_>)], ) -> Result<(), Error>

Writes an inner gutter, with the left lines if necessary.

Trait Implementations

impl Write for Renderer<'_, '_>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result

Glue for usage of the write! macro with implementors of this trait.