Struct ErrCode 

pub struct ErrCode {
    pub reason: u16,
    pub detail: &'static str,
}

Static error descriptor used to construct FrozenError

Example

use frozen_core::error::ErrCode;

const LOCK_ERR: ErrCode = frozen_core::error::ErrCode::new(0x300, "lock error");

assert_eq!(LOCK_ERR.reason, 0x300);
assert_eq!(LOCK_ERR.detail, "lock error");

Fields

reason: u16

16-bit reason code encoded into FrozenError::id

detail: &'static str

Short subsystem label included in the formatted error context

Implementations

impl ErrCode

pub const fn new(reason: u16, detail: &'static str) -> Self

Create a new ErrCode

NOTE: This function is const, allowing error codes to be defined as compile-time constants

Example

use frozen_core::error::ErrCode;

const LOCK_ERR: ErrCode = frozen_core::error::ErrCode::new(0x300, "lock error");

assert_eq!(LOCK_ERR.reason, 0x300);
assert_eq!(LOCK_ERR.detail, "lock error");

Trait Implementations

impl Clone for ErrCode

fn clone(&self) -> ErrCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrCode

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

Formats the value using the given formatter.