Struct embedded_error_chain::ErrorData

#[repr(transparent)]pub struct ErrorData { /* fields omitted */ }

The entire data of the error and its error code chain.

Implementations

impl ErrorData

pub const fn new(error_code: ErrorCode) -> ErrorData

Create new ErrorData that conains the supplied error_code and has an empty chain.

pub fn set_code(&mut self, code: ErrorCode) -> ErrorCode

Replace the error code with code and return the old one.

Note: That the categories of the new error code and the old must be the same.

pub fn code(&self) -> ErrorCode

Get the error code of the error.

pub fn first_formatter_index(&self) -> Option<u8>

Get the first formatter index in the chain if available.

pub fn chain_len(&self) -> usize

The number of chained error codes (does not include the error code representing this error).

pub fn chain_full(&self) -> bool

Wether the error chain is full.

pub fn push_front(
    &mut self,
    error_code: ErrorCode,
    category_index: u8
) -> Option<(ErrorCode, u8)>

Push onto the front of the error chain, return the back of the chain before and if it gets overwritten (when the chain overflows).

Note: error_code is masked to the first 4 bits and category_index is masked to the first 3 bits.

pub fn chain(&mut self, error_code: ErrorCode, category_index: u8)

Chain this error with a new error specified by error_code and category_index.

TODO: document

Trait Implementations

impl Clone for ErrorData

fn clone(&self) -> ErrorData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorData

impl Eq for ErrorData

impl PartialEq<ErrorData> for ErrorData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for ErrorData

impl StructuralPartialEq for ErrorData