Struct Renderer 

pub struct Renderer { /* private fields */ }

The Renderer for a Report

The caller is expected to detect any relevant terminal features and configure the renderer, including

• ANSI Escape code support (always outputted with Renderer::styled)
• Terminal width (Renderer::term_width)
• Unicode support (Renderer::decor_style)

Example

let report = // ...

let renderer = Renderer::styled();
let output = renderer.render(report);
anstream::println!("{output}");

Implementations

impl Renderer

pub const fn plain() -> Self

No terminal styling

pub const fn styled() -> Self

Default terminal styling

If ANSI escape codes are not supported, either

• Call Renderer::plain instead
• Strip them after the fact, like with anstream

Note

When testing styled terminal output, see the testing-colors feature

pub const fn no_graphics(self, no_graphics: bool) -> Self

Render a Report without source snippets or graphical decorations

The output is primarily designed for Text-To-Speech and Braille displays. It also provides a more detailed alternative to Renderer::short_message.

We recommend that applications enable this format when NO_GRAPHICS=1 is set in the environment.

This format supports colors and hyperlinks.

Renderer::plain can be used to disable colors and hyperlinks.

Example output

error E0308: mismatched types
 at $DIR/bad-hex-float-lit.rs:2:19: expected `f32`, found integer
  on line 2, column 13: expected due to this
help: rewrite this as a decimal floating point literal, or use `as` to turn a hex literal into a float
 option 1
  on line 2, column 19 to column 27 replace with: 0xAB as f32
 option 2
  on line 2, column 19 to column 27 replace with: 171_f32

pub const fn short_message(self, short_message: bool) -> Self

Abbreviate the message

pub const fn term_width(self, term_width: usize) -> Self

Set the width to render within

Affects the rendering of Snippets

pub const fn decor_style(self, decor_style: DecorStyle) -> Self

Set the character set used for rendering decor

pub const fn anonymized_snippet_line_numbers(self, yes: bool) -> Self

Anonymize snippet line numbers

When enabled, line numbers are replaced with LL which is useful for tests.

Example

  --> $DIR/whitespace-trimming.rs:4:193
   |
LL | ...                   let _: () = 42;
   |                                   ^^ expected (), found integer
   |

pub const fn anonymized_line_numbers(self, yes: bool) -> Self

👎Deprecated since 0.12.17:

replaced with Renderer::anonymized_snippet_line_numbers

Deprecated, replaced with Self::anonymized_snippet_line_numbers

pub const fn anonymized_origin_line_numbers(self, yes: bool) -> Self

Anonymize origin line numbers

When enabled, line numbers are replaced with LL which is useful for tests.

Example

  --> $DIR/whitespace-trimming.rs:LL:193
  |
4 | ...                   let _: () = 42;
  |                                   ^^ expected (), found integer
  |

impl Renderer

pub fn render(&self, groups: Report<'_>) -> String

Render a diagnostic Report

impl Renderer

Customize Renderer::styled

pub const fn error(self, style: Style) -> Self

Override the output style for error

pub const fn warning(self, style: Style) -> Self

Override the output style for warnings

pub const fn info(self, style: Style) -> Self

Override the output style for info

pub const fn note(self, style: Style) -> Self

Override the output style for notes

pub const fn help(self, style: Style) -> Self

Override the output style for help

pub const fn line_num(self, style: Style) -> Self

Override the output style for line numbers in the Snippet gutter

pub const fn emphasis(self, style: Style) -> Self

Override the output style for emphasis for the primary_title

pub const fn context(self, style: Style) -> Self

Override the output style for AnnotationKind::Context

pub const fn addition(self, style: Style) -> Self

Override the output style for Patch additions

pub const fn removal(self, style: Style) -> Self

Override the output style for Patch removals

pub const fn none(self, style: Style) -> Self

Override the output style for all other text

pub const fn hyperlink(self, hyperlink: bool) -> Self

Override whether hyperlinks should be emitted

Trait Implementations

impl Clone for Renderer

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 Renderer

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

Formats the value using the given formatter.