Struct miette::MietteHandlerOpts

source · [−]

pub struct MietteHandlerOpts { /* private fields */ }

Expand description

Create a custom MietteHandler from options.

Example

miette::set_hook(Box::new(|_| {
    Box::new(miette::MietteHandlerOpts::new()
        .terminal_links(true)
        .unicode(false)
        .context_lines(3)
        .build())
}))

Implementations

source

impl MietteHandlerOpts

source

pub fn new() -> Self

Create a new MietteHandlerOpts.

source

pub fn terminal_links(self, linkify: bool) -> Self

If true, specify whether the graphical handler will make codes be clickable links in supported terminals. Defaults to auto-detection based on known supported terminals.

source

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

Set a graphical theme for the handler when rendering in graphical mode. Use force_graphical() to force graphical mode. This option overrides color().

source

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

Sets the width to wrap the report at. Defaults to 80.

source

pub fn with_cause_chain(self) -> Self

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

source

pub fn without_cause_chain(self) -> Self

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

source

pub fn color(self, color: bool) -> Self

If true, colors will be used during graphical rendering, regardless of whether or not the terminal supports them.

If false, colors will never be used.

If unspecified, colors will be used only if the terminal supports them.

The actual format depends on the value of MietteHandlerOpts::rgb_colors.

source

pub fn rgb_colors(self, color: RgbColors) -> Self

Controls which color format to use if colors are used in graphical rendering.

The default is Never.

This value does not control whether or not colors are being used in the first place. That is handled by the MietteHandlerOpts::color setting. If colors are not being used, the value of rgb_colors has no effect.

source

pub fn unicode(self, unicode: bool) -> Self

If true, forces unicode display for graphical output. If set to false, forces ASCII art display.

source

pub fn force_graphical(self, force: bool) -> Self

If true, graphical rendering will be used regardless of terminal detection.

source

pub fn force_narrated(self, force: bool) -> Self

If true, forces use of the narrated renderer.

Set a footer to be displayed at the bottom of the report.

source

pub fn context_lines(self, context_lines: usize) -> Self

Sets the number of context lines before and after a span to display.

source

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

Set the displayed tab width in spaces.

source

pub fn build(self) -> MietteHandler

Builds a MietteHandler from this builder.

Trait Implementations

source

impl Clone for MietteHandlerOpts

source

fn clone(&self) -> MietteHandlerOpts

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 MietteHandlerOpts

source

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

Formats the value using the given formatter. Read more

source

impl Default for MietteHandlerOpts

source

fn default() -> MietteHandlerOpts

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

Auto Trait Implementations

impl RefUnwindSafe for MietteHandlerOpts

impl Send for MietteHandlerOpts

impl Sync for MietteHandlerOpts

impl Unpin for MietteHandlerOpts

impl UnwindSafe for MietteHandlerOpts

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
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 T where
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 self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

source

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

Change the background color to black

source

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

Change the foreground color to red

source

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

Change the background color to red

source

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

Change the foreground color to green

source

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

Change the background color to green

source

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

Change the foreground color to yellow

source

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

Change the background color to yellow

source

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

Change the foreground color to blue

source

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

Change the background color to blue

source

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

Change the foreground color to magenta

source

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

Change the background color to magenta

source

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

Change the foreground color to purple

source

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

Change the background color to purple

source

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

Change the foreground color to cyan

source

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

Change the background color to cyan

source

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

Change the foreground color to white

source

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

Change the background color to white

source

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

Change the foreground color to the terminal default

source

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

Change the background color to the terminal default

source

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

Change the foreground color to bright black

source

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

Change the background color to bright black

source

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

Change the foreground color to bright red

source

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

Change the background color to bright red

source

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

Change the foreground color to bright green

source

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

Change the background color to bright green

source

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

Change the foreground color to bright yellow

source

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

Change the background color to bright yellow

source

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

Change the foreground color to bright blue

source

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

Change the background color to bright blue

source

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

Change the foreground color to bright magenta

source

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

Change the background color to bright magenta

source

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

Change the foreground color to bright purple

source

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

Change the background color to bright purple

source

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

Change the foreground color to bright cyan

source

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

Change the background color to bright cyan

source

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

Change the foreground color to bright white

source

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

Change the background color to bright white

source

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

Make the text bold

source

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

Make the text dim

source

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

Make the text italicized

source

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

Make the text italicized

source

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

Make the text blink

source

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

Make the text blink (but fast!)

source

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

Swap the foreground and background colors

source

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

Hide the text

source

fn strikethrough(&'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 T where
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 T where
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 T where
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::MietteHandlerOpts

Example

Implementations

impl MietteHandlerOpts

pub fn new() -> Self

pub fn terminal_links(self, linkify: bool) -> Self

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

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

pub fn with_cause_chain(self) -> Self

pub fn without_cause_chain(self) -> Self

pub fn color(self, color: bool) -> Self

pub fn rgb_colors(self, color: RgbColors) -> Self

pub fn unicode(self, unicode: bool) -> Self

pub fn force_graphical(self, force: bool) -> Self

pub fn force_narrated(self, force: bool) -> Self

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

pub fn context_lines(self, context_lines: usize) -> Self

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

pub fn build(self) -> MietteHandler

Trait Implementations

impl Clone for MietteHandlerOpts

fn clone(&self) -> MietteHandlerOpts

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

impl Debug for MietteHandlerOpts

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

impl Default for MietteHandlerOpts

fn default() -> MietteHandlerOpts

Auto Trait Implementations

impl RefUnwindSafe for MietteHandlerOpts

impl Send for MietteHandlerOpts

impl Sync for MietteHandlerOpts

impl Unpin for MietteHandlerOpts

impl UnwindSafe for MietteHandlerOpts

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where 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 T where 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 self) -> FgColorDisplay<'a, Black, Self>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T, U> Into<U> for T where
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 T where
T: Clone,

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

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