Struct MietteHandlerOpts

pub struct MietteHandlerOpts { /* private fields */ }

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

impl MietteHandlerOpts

pub fn new() -> Self

Create a new MietteHandlerOpts.

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.

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().

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

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

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

If true, colors will be used during graphical rendering. Actual color format will be auto-detected.

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

If true, RGB colors will be used during graphical rendering.

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

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

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

If true, ANSI colors will be used during graphical rendering.

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

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

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

If true, forces use of the narrated renderer.

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

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

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

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

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

Set the displayed tab width in spaces.

pub fn build(self) -> MietteHandler

Builds a MietteHandler from this builder.

Trait Implementations

impl Clone for MietteHandlerOpts

fn clone(&self) -> MietteHandlerOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MietteHandlerOpts

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

Formats the value using the given formatter.

impl Default for MietteHandlerOpts

fn default() -> MietteHandlerOpts

Returns the “default value” for a type.