Struct ERGlobalSettings 

pub struct ERGlobalSettings {
    pub link_format: LinkDebugIde,
    pub check_known_error_types_fn: fn(&str) -> Option<String>,
    pub submit_error_reporter_fn: for<'a> fn(&'a ErrorReport) -> Box<dyn SubmitErrorReport<'a> + 'a>,
}

Global configuration for the error report system.

Set once at application startup via GlobalSettings::set_global_settings.

Fields

link_format: LinkDebugIde

Controls how source locations are rendered in terminal output.

LinkDebugIde::File emits clickable file:// hyperlinks, LinkDebugIde::Vscode emits vscode://file/ links, and LinkDebugIde::NoLink outputs plain file:line:column text.

Automatically overridden to LinkDebugIde::NoLink when the NO_COLOR environment variable is set.

Default: LinkDebugIde::File

check_known_error_types_fn: fn(&str) -> Option<String>

Function called during a panic to check if the error message matches a known issue. Receives the panic message as &str.

Return Some(message) with a user-friendly explanation if the error is recognized, or None to treat it as an unknown error and generate a full report.

Used by setup_panic! before building the error submission report.

Default: check_known_error_types_default (always returns None)

submit_error_reporter_fn: for<'a> fn(&'a ErrorReport) -> Box<dyn SubmitErrorReport<'a> + 'a>

Function that creates a SubmitErrorReport from an ErrorReport.

Used by setup_panic! to generate error submission reports.

Default: creates a SimpleErrorReport

Implementations

impl ERGlobalSettings

pub fn get_or_default_settings() -> Result<RwLockReadGuard<'static, Self>, ErrorReport>

Read the global settings, initializing with Default if not yet set.

Unlike GlobalSettings::get_global_settings which returns an error when unset, this method lazily creates a default configuration.

Trait Implementations

impl Clone for ERGlobalSettings

fn clone(&self) -> ERGlobalSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ERGlobalSettings

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

Formats the value using the given formatter.

impl Default for ERGlobalSettings

fn default() -> Self

Returns the “default value” for a type.

impl From<&ERGlobalSettings> for ErrorFmtSettings

fn from(settings: &ERGlobalSettings) -> Self

Converts to this type from the input type.

impl From<ERGlobalSettings> for ErrorFmtSettings

fn from(settings: ERGlobalSettings) -> Self

Converts to this type from the input type.

impl GlobalSettings for ERGlobalSettings

type Setting = ERGlobalSettings

The settings type stored in the global lock.

fn once_lock() -> &'static OnceLock<RwLock<Self::Setting>>

Return a reference to the static OnceLock that holds this setting.

fn get_setting_object_name() -> &'static str

Return a human-readable name for this settings object (used in error messages).

fn set_global_settings(setting: Self::Setting) -> Result<(), ErrorReport>

where <Self as GlobalSettings>::Setting: 'static,

Initialize the global simple report configuration. Must be called once at startup.

fn get_global_settings() -> Result<RwLockReadGuard<'static, Self::Setting>, ErrorReport>

Read the global simple report configuration. Returns an error if not yet set.

fn is_set() -> bool

where <Self as GlobalSettings>::Setting: 'static,

Checks if the global setting have been set. Returns true if set, false is not yet set (or is being set).