Renderer

Struct Renderer 

Source
pub struct Renderer { /* private fields */ }
Expand description

The Renderer for a Report

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

§Example

let report = // ...

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

Implementations§

Source§

impl Renderer

Source

pub const fn plain() -> Self

No terminal styling

Source

pub const fn styled() -> Self

Default terminal styling

If ANSI escape codes are not supported, either

§Note

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

Source

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

Abbreviate the message

Source

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

Set the width to render within

Affects the rendering of Snippets

Source

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

Set the character set used for rendering decor

Source

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

Anonymize 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
   |
Source§

impl Renderer

Source

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

Render a diagnostic Report

Source§

impl Renderer

Customize Renderer::styled

Source

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

Override the output style for error

Source

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

Override the output style for warning

Source

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

Override the output style for info

Source

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

Override the output style for note

Source

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

Override the output style for help

Source

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

Override the output style for line numbers

Source

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

Override the output style for emphasis

Source

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

Override the output style for none

Source

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

Override the output style for AnnotationKind::Context

Source

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

Override the output style for additions

Source

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

Override the output style for removals

Trait Implementations§

Source§

impl Clone for Renderer

Source§

fn clone(&self) -> Renderer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Renderer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.