Struct Errors

pub struct Errors {
    pub(crate) output: RefCell<Box<dyn Write + Send>>,
    pub(crate) loaded_mods_labels: Vec<String>,
    pub(crate) loaded_dlcs_labels: Vec<String>,
    pub(crate) cache: Cache,
    pub(crate) filter: ReportFilter,
    pub(crate) styles: OutputStyle,
    pub(crate) suppress: HashMap<SuppressionKey, Vec<Vec<SuppressionLocation>>>,
    storage: HashSet<LogReport>,
}

Fields

output: RefCell<Box<dyn Write + Send>>

loaded_mods_labels: Vec<String>

Extra loaded mods’ error tags.

loaded_dlcs_labels: Vec<String>

Loaded DLCs’ error tags.

cache: Cache

filter: ReportFilter

Determines whether a report should be printed.

styles: OutputStyle

Output color and style configuration.

suppress: HashMap<SuppressionKey, Vec<Vec<SuppressionLocation>>>

storage: HashSet<LogReport>

All reports that passed the checks, stored here to be sorted before being emitted all at once. The “abbreviated” reports don’t participate in this. They are still emitted immediately. It’s a HashSet because duplicate reports are fairly common due to macro expansion and other revalidations.

Implementations

impl Errors

fn should_suppress(&mut self, report: &LogReport) -> bool

fn push_report(&mut self, report: LogReport)

Perform some checks to see whether the report should actually be logged. If yes, it will add it to the storage.

pub fn push_abbreviated<E: ErrorLoc>(&mut self, eloc: E, key: ErrorKey)

Immediately log a single-line report about this error.

This is intended for voluminous almost-identical errors, such as from the “unused localization” check.

pub fn push_header(&mut self, _key: ErrorKey, msg: &str)

Immediately print an error message. It is intended to introduce a following block of messages printed with Errors::push_abbreviated.

pub fn take_reports(&mut self) -> Vec<LogReport>

Extract the stored reports, sort them, and return them as a vector of LogReport. The stored reports will be left empty.

pub fn emit_reports(&mut self, json: bool)

Print all the stored reports to the error output. Set json if they should be printed as a JSON array. Otherwise they are printed in the default output format.

Note that the default output format is not stable across versions. It is meant for human readability and occasionally gets changed to improve that.

pub fn store_source_file(&mut self, fullpath: PathBuf, source: &'static str)

pub fn get_mut() -> MutexGuard<'static, Errors>

Get a mutable lock on the global ERRORS struct.

Panics

May panic when the mutex has been poisoned by another thread.

pub fn get() -> MutexGuard<'static, Errors>

Like Errors::get_mut but intended for read-only access.

Currently there is no difference, but if the locking mechanism changes there may be a difference.

Panics

May panic when the mutex has been poisoned by another thread.

Trait Implementations

impl Default for Errors

fn default() -> Self

Returns the “default value” for a type.