Struct tiger_lib::report::Errors

pub struct Errors { /* private fields */ }

Implementations

impl Errors

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