Enum ockam_core::errcode::Origin

#[non_exhaustive]
#[repr(u8)]
pub enum Origin {
    Unknown = 0,
    Application = 1,
    Vault = 2,
    Transport = 3,
    Node = 4,
    Api = 5,
    Identity = 6,
    Channel = 7,
    KeyExchange = 8,
    Executor = 9,
    Core = 10,
    Ockam = 11,
    Authorization = 12,
    Other = 13,
}

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 = 0

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 = 1

Reserved for errors emitted by applications using ockam.

Vault = 2

An error originating from the vault.

Transport = 3

Errors emitted by the transport layer.

Node = 4

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

Api = 5

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

Identity = 6

Errors from within the identity-management code.

Channel = 7

Errors from the secure channel implementation.

KeyExchange = 8

Errors occurring from the one of the key exchange implementations.

Executor = 9

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

Core = 10

Other errors from within ockam or ockam_core.

Ockam = 11

Ockam protocol crate

Authorization = 12

Errors from within the Ockam authorization code.

Other = 13

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<Self>

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<u8> for Origin

fn from(src: u8) -> Self

Converts to this type from the input type.

impl Hash for Origin

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, Self: Sized,

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Origin

impl Eq for Origin

impl StructuralPartialEq for Origin