Struct NarratableReportHandler

pub struct NarratableReportHandler { /* private fields */ }

ReportHandler that renders plain text and avoids extraneous graphics. It’s optimized for screen readers and braille users, but is also used in any non-graphical environments, such as non-TTY output.

Implementations

impl NarratableReportHandler

pub const fn new() -> Self

Create a new NarratableReportHandler. There are no customization options.

pub const fn with_cause_chain(self) -> Self

Include the cause chain of the top-level error in the report, if available.

pub const fn without_cause_chain(self) -> Self

Do not include the cause chain of the top-level error in the report.

pub fn with_footer(self, footer: String) -> Self

Set the footer to be displayed at the end of the report.

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

Sets the number of lines of context to show around each error.

impl NarratableReportHandler

pub fn render_report( &self, f: &mut impl Write, diagnostic: &dyn Diagnostic, ) -> Result

Render a Diagnostic. This function is mostly internal and meant to be called by the toplevel ReportHandler handler, but is made public to make it easier (possible) to test in isolation from global state.

Trait Implementations

impl Clone for NarratableReportHandler

fn clone(&self) -> NarratableReportHandler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NarratableReportHandler

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

Formats the value using the given formatter.

impl Default for NarratableReportHandler

fn default() -> Self

Returns the “default value” for a type.

impl ReportHandler for NarratableReportHandler

fn debug(&self, diagnostic: &dyn Diagnostic, f: &mut Formatter<'_>) -> Result

Define the report format

fn display( &self, error: &(dyn StdError + 'static), f: &mut Formatter<'_>, ) -> Result

Override for the Display format

fn track_caller(&mut self, location: &'static Location<'static>)

Store the location of the caller who constructed this error report