Struct ErrorMapping

pub struct ErrorMapping {
    pub error_categories: BTreeMap<u64, ErrorDescription>,
    pub module_error_maps: BTreeMap<ModuleId, BTreeMap<u64, ErrorDescription>>,
}

Fields

error_categories: BTreeMap<u64, ErrorDescription>

The set of error categories and their descriptions

module_error_maps: BTreeMap<ModuleId, BTreeMap<u64, ErrorDescription>>

The set of modules, and the module-specific errors

Implementations

impl ErrorMapping

pub fn add_error_category( &mut self, category_id: u64, description: ErrorDescription, ) -> Result<()>

pub fn add_module_error( &mut self, module_id: ModuleId, abort_code: u64, description: ErrorDescription, ) -> Result<()>

pub fn from_file<P: AsRef<Path>>(path: P) -> Self

pub fn to_file<P: AsRef<Path>>(&self, path: P)

pub fn get_explanation( &self, module: &ModuleId, output_code: u64, ) -> Option<ErrorContext>

Trait Implementations

impl Clone for ErrorMapping

fn clone(&self) -> ErrorMapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorMapping

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

Formats the value using the given formatter.

impl Default for ErrorMapping

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ErrorMapping

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ErrorMapping

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.