Struct ContextFormattingStyle 

pub struct ContextFormattingStyle {
    pub function: FormattingFunction,
    pub follow_source: bool,
    pub follow_source_depth: Option<usize>,
}

Formatting preferences for a context when displayed in a report.

This struct allows a ContextHandler to specify how it prefers to be formatted when its context is displayed as part of an error report. The formatting system may or may not respect these preferences depending on the formatter implementation.

Fields

• function: Whether to use Display or Debug formatting
• follow_source: Whether to follow the Error::source-chain when ContextHandler::source returns Some.
• follow_source_depth: How deep to follow the chain, None means no limit.

Default

The default is to use FormattingFunction::Display and not to chase sources at all.

Examples

use rootcause_internals::handlers::{ContextFormattingStyle, FormattingFunction};

// Prefer display formatting (the default)
let style = ContextFormattingStyle::default();
assert_eq!(style.function, FormattingFunction::Display);

// Explicitly request debug formatting
let debug_style = ContextFormattingStyle {
    function: FormattingFunction::Debug,
    follow_source: false,
    follow_source_depth: None,
};

Fields

function: FormattingFunction

The preferred formatting function to use

follow_source: bool

Whether to follow the core::error::Error source chain when formatting

follow_source_depth: Option<usize>

The maximum depth to follow the core::error::Error source chain when formatting. Setting to None means unlimited depth.

Trait Implementations

impl Clone for ContextFormattingStyle

fn clone(&self) -> ContextFormattingStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextFormattingStyle

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

Formats the value using the given formatter.

impl Default for ContextFormattingStyle

fn default() -> ContextFormattingStyle

Returns the “default value” for a type.

impl Copy for ContextFormattingStyle