Struct miette::GraphicalReportHandler

source ·

pub struct GraphicalReportHandler { /* private fields */ }

Expand description

A ReportHandler that displays a given Report in a quasi-graphical way, using terminal colors, unicode drawing characters, and other such things.

This is the default reporter bundled with miette.

This printer can be customized by using new_themed() and handing it a GraphicalTheme of your own creation (or using one of its own defaults!)

See set_hook() for more details on customizing your global printer.

Implementations

source

impl GraphicalReportHandler

source

pub fn new() -> Self

Create a new GraphicalReportHandler with the default GraphicalTheme. This will use both unicode characters and colors.

source

pub fn new_themed(theme: GraphicalTheme) -> Self

Create a new GraphicalReportHandler with a given GraphicalTheme.

source

pub fn tab_width(self, width: usize) -> Self

Set the displayed tab width in spaces.

source

pub fn with_links(self, links: bool) -> Self

Whether to enable error code linkification using Diagnostic::url().

source

pub fn with_cause_chain(self) -> Self

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

source

pub fn without_cause_chain(self) -> Self

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

source

pub fn with_urls(self, urls: bool) -> Self

Whether to include Diagnostic::url() in the output.

Disabling this is not recommended, but can be useful for more easily reproducable tests, as url(docsrs) links are version-dependent.

source

pub fn with_theme(self, theme: GraphicalTheme) -> Self

Set a theme for this handler.

source

pub fn with_width(self, width: usize) -> Self

Sets the width to wrap the report at.

source

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

Sets the ‘global’ footer for this handler.

source

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

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

source

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

source

impl Clone for GraphicalReportHandler

source

fn clone(&self) -> GraphicalReportHandler

Returns a copy 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 GraphicalReportHandler

source

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

Formats the value using the given formatter. Read more

source

impl Default for GraphicalReportHandler

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl ReportHandler for GraphicalReportHandler

source

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

Define the report format Read more

source

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

Override for the Display format

source

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

Store the location of the caller who constructed this error report

Auto Trait Implementations

impl RefUnwindSafe for GraphicalReportHandler

impl Send for GraphicalReportHandler

impl Sync for GraphicalReportHandler

impl Unpin for GraphicalReportHandler

impl UnwindSafe for GraphicalReportHandler

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<D> OwoColorize for D

source

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

Set the foreground color generically Read more

source

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

Set the background color generically. Read more

source

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

source

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

source

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

source

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

source

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

source

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

source

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

source

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

source

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

source

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

source

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

source

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

source

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

source

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

source

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

source

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

source

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

source

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

source

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

source

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

source

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

source

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

source

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

source

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

source

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

source

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

source

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

source

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

source

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

source

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

source

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

source

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

source

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

source

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

source

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

source

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

source

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

source

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

source

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

source

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim

source

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

source

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

source

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

source

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

source

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

source

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

source

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

source

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

source

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

source

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

source

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

source

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

source

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

source

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

source

impl<T> ToOwned for Twhere
T: Clone,

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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct miette::GraphicalReportHandler

Implementations

impl GraphicalReportHandler

pub fn new() -> Self

pub fn new_themed(theme: GraphicalTheme) -> Self

pub fn tab_width(self, width: usize) -> Self

pub fn with_links(self, links: bool) -> Self

pub fn with_cause_chain(self) -> Self

pub fn without_cause_chain(self) -> Self

pub fn with_urls(self, urls: bool) -> Self

pub fn with_theme(self, theme: GraphicalTheme) -> Self

pub fn with_width(self, width: usize) -> Self

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

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

impl GraphicalReportHandler

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

Trait Implementations

impl Clone for GraphicalReportHandler

fn clone(&self) -> GraphicalReportHandler

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

impl Debug for GraphicalReportHandler

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

impl Default for GraphicalReportHandler

fn default() -> Self

impl ReportHandler for GraphicalReportHandler

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

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

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

Auto Trait Implementations

impl RefUnwindSafe for GraphicalReportHandler

impl Send for GraphicalReportHandler

impl Sync for GraphicalReportHandler

impl Unpin for GraphicalReportHandler

impl UnwindSafe for GraphicalReportHandler

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

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

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

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

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

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

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

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T> ToOwned for Twhere
T: Clone,

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

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