Struct TextRenderOptions 

#[non_exhaustive]
pub struct TextRenderOptions {
    pub enable_hyperlinks: bool,
    pub enable_color: bool,
}

Options for rendering diagnostic messages to text.

This struct controls various aspects of text rendering, such as whether to include terminal hyperlinks for clickable file paths or ANSI color in the source-context snippet.

The default enables everything a terminal can use (color and OSC 8 hyperlinks). TextRenderOptions::plain disables both, producing text with no escape sequences of any kind — for logs, JSON transport, and other machine consumers.

The struct is #[non_exhaustive]: construct it from TextRenderOptions::default or TextRenderOptions::plain and adjust it with the builder methods, so new options can be added without breaking callers.

Example

use quarto_error_reporting::TextRenderOptions;

// Terminal output without hyperlinks (e.g. for snapshot tests).
let opts = TextRenderOptions::default().hyperlinks(false);
assert!(opts.enable_color && !opts.enable_hyperlinks);

// No escape sequences at all.
let plain = TextRenderOptions::plain();
assert!(!plain.enable_color && !plain.enable_hyperlinks);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enable_hyperlinks: bool

Enable OSC 8 hyperlinks for clickable file paths in terminals.

When enabled, file paths in error messages will include terminal escape codes for clickable links (supported by iTerm2, VS Code, etc.). Disable for snapshot testing to avoid absolute path differences.

enable_color: bool

Enable ANSI (SGR) color codes in the source-context snippet.

When disabled, the snippet renderer draws the same layout with no color escape sequences. Independent of enable_hyperlinks: disable both (see TextRenderOptions::plain) for output free of escape bytes.

Implementations

impl TextRenderOptions

pub fn plain() -> Self

Options producing text with no escape sequences of any kind: no ANSI color and no OSC 8 hyperlinks.

pub fn hyperlinks(self, enable: bool) -> Self

Set whether file paths carry OSC 8 hyperlinks (see enable_hyperlinks).

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

Set whether the source-context snippet carries ANSI color (see enable_color).

Trait Implementations

impl Clone for TextRenderOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextRenderOptions

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

Formats the value using the given formatter.

impl Default for TextRenderOptions

fn default() -> Self

Returns the “default value” for a type.