Struct miette::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 with_syntax_highlighting( self, highlighter: impl Highlighter + Send + Sync + 'static, ) -> Self

Set a syntax highlighter when rendering in graphical mode. Use force_graphical() to force graphical mode.

Syntax highlighting is disabled by default unless the syntect-highlighter feature is enabled. Call this method to override the default and use a custom highlighter implmentation instead.

Use without_syntax_highlighting() To disable highlighting completely.

Setting this option will not force color output. In all cases, the current color configuration via color() takes precedence over highlighter configuration.

pub fn without_syntax_highlighting(self) -> Self

Disables syntax highlighting when rendering in graphical mode. Use force_graphical() to force graphical mode.

Syntax highlighting is disabled by default unless the syntect-highlighter feature is enabled. Call this method if you want to disable highlighting when building with this feature.

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

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

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

If true, long lines can be wrapped.

If false, long lines will not be broken when they exceed the width.

Defaults to true.

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

If true, long words can be broken when wrapping.

If false, long words will not be broken when they exceed the width.

Defaults to true.

pub fn word_separator(self, word_separator: WordSeparator) -> Self

Sets the textwrap::WordSeparator to use when determining wrap points.

pub fn word_splitter(self, word_splitter: WordSplitter) -> Self

Sets the textwrap::WordSplitter to use when determining wrap points.

pub fn with_cause_chain(self) -> Self

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

pub fn without_cause_chain(self) -> Self

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

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.

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.

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