Struct FrozenError 

pub struct FrozenError {
    pub module: u8,
    pub domain: u8,
    pub reason: u8,
    pub context: Box<str>,
}

Utility for error propagation used across [frozen_core]

Fields

module: u8

8-bit unique identifier to identify the module of FrozenError object

domain: u8

8-bit unique identifier to identify the domain of FrozenError object

reason: u8

8-bit unique identifier to identify the reason of FrozenError object

context: Box<str>

Error context for the FrozenError

Implementations

impl FrozenError

pub fn new(module: u8, domain: u8, code: ErrCode, errmsg: &str) -> Self

Construct a new FrozenError

Example

use frozen_core::error::{FrozenError, ErrCode};

let err = FrozenError::new(0x10, 0x20, ErrCode::new(0x30, "io"), "failed to read file");

assert_eq!(err.module, 0x10);
assert_eq!(err.domain, 0x20);
assert_eq!(err.reason, 0x30);

assert!(err.context.contains("[io]"));
assert!(err.context.contains("failed to read file"));

pub fn new_raw<E: Display>( module: u8, domain: u8, code: ErrCode, err: E, ) -> Self

Construct a new FrozenError from raw [Error] object

Example

use frozen_core::error::{FrozenError, ErrCode};

let io_err = std::io::Error::new(std::io::ErrorKind::NotFound, "file missing");
let err = FrozenError::new_raw(0x14, 0x24, ErrCode::new(0x34, "io"), io_err);

assert_eq!(err.module, 0x14);
assert_eq!(err.domain, 0x24);
assert_eq!(err.reason, 0x34);

assert!(err.context.contains("[io]"));
assert!(err.context.contains("file missing"));

Trait Implementations

impl Clone for FrozenError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrozenError

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

Formats the value using the given formatter.

impl Display for FrozenError

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

Formats the value using the given formatter.

impl Error for FrozenError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for FrozenError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.