Struct ockam_core::errcode::ErrorCode

#[non_exhaustive]
pub struct ErrorCode {
    pub origin: Origin,
    pub kind: Kind,
    pub extra: i32,
}

A set of abstract error codes describing an error. See the module-level documentation for details.

The fields of this struct are pub for matching, but you need to go through one of the constructor functions to create one of these (and not a literal), as it is a #[non_exhaustive] type (which may change in the future, since it’s unclear if this provides value).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

origin: Origin

The Origin of this error.

kind: Kind

The Kind of this error.

extra: i32

An additional identifying numeric payload, or 0 if none is relevant.

For example, it would be reasonable for this field to hold:

• HTTP status code
• OS errno/GetLastError code
• The exit status returned by a subprocess
• A numeric error code from some other system
• Et cetera.

But should generally not be used to hold non-identifying metadata, such as the date, device IDs, as that information should be stored on the payload itself.

Concretely: two ErrorCode with different extra values should identify types of errors.

Implementations

impl ErrorCode

pub fn new(origin: Origin, kind: Kind) -> Self

Construct the ErrorCode for an error.

pub fn new_with_extra(origin: Origin, kind: Kind, extra: i32) -> Self

Construct the ErrorCode for an error which contains an additional numeric payload.

pub fn unknown() -> Self

Construct an error code with very little useful information

pub fn update_unknown(
    self,
    o: impl Into<Option<Origin>>,
    k: impl Into<Option<Kind>>
) -> Self

Attach an origin and/or kind to the error, without risk of overwriting more precise information value.

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl Hash for ErrorCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for ErrorCode

fn cmp(&self, other: &ErrorCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ErrorCode> for ErrorCode

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ErrorCode> for ErrorCode

fn partial_cmp(&self, other: &ErrorCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ErrorCode

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

Serialize this value into the given Serde serializer.

impl Copy for ErrorCode

impl Eq for ErrorCode

impl StructuralEq for ErrorCode

impl StructuralPartialEq for ErrorCode