Enum ockam::errcode::Origin

#[repr(u8)]
#[non_exhaustive]
pub enum Origin {
    Unknown,
    Application,
    Vault,
    Transport,
    Node,
    Api,
    Identity,
    Channel,
    KeyExchange,
    Executor,
    Core,
    Ockam,
    Other,
}

Origin indicates the abstract source of an error.

Note that Error should already contain precise origin information (file, line) where the error originated from.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown

An error for which there is no way to determine a more specific origin.

Eventually this should also be used for errors which, during deserialization, have an unknown Origin (for now this is too error-prone for various reasons).

Application

Reserved for errors emitted by applications using ockam.

Vault

An error originating from the vault.

Transport

Errors emitted by the transport layer.

Node

Errors from some part of the node implementation — the router or relay, for example.

Api

Errors from the surface API — for example: the FFI layer.

Identity

Errors from within the identity-management code.

Channel

Errors from the secure channel implementation.

KeyExchange

Errors occurring from the one of the key exchange implementations.

Executor

An error which occurs in the executor (e.g. ockam_executor, since tokio errors will likely come from elsewhere).

Core

Other errors from within ockam or ockam_core.

Ockam

Ockam protocol crate

Other

Errors from other sources, such as libraries extending ockam.

Note: The actual source (file, line, …) will (hopefully) be available on the error itself, as one of the members of the payload.

Implementations

impl Origin

pub fn from_u8(n: u8) -> Option<Origin>

Attempt to convert a numeric value into an Origin.

From<u8> is also implemented, replacing unknown inputs with Self::Unknown.

Trait Implementations

impl Clone for Origin

fn clone(&self) -> Origin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Origin

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Origin

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

Deserialize this value from the given Serde deserializer.

impl From<u8> for Origin

fn from(src: u8) -> Origin

Converts to this type from the input type.

impl Hash for Origin

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

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 Origin

fn cmp(&self, other: &Origin) -> 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) -> Self

Restrict a value to a certain interval.

impl PartialEq<Origin> for Origin

fn eq(&self, other: &Origin) -> 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 !=.

impl PartialOrd<Origin> for Origin

fn partial_cmp(&self, other: &Origin) -> 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 Origin

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

Serialize this value into the given Serde serializer.

impl Copy for Origin

impl Eq for Origin

impl StructuralEq for Origin

impl StructuralPartialEq for Origin