Struct ockam_core::Error

pub struct Error(_);

The type of errors returned by Ockam functions.

Errors store:

• A set of error codes, which abstractly describe the problem and allow easily matching against specific categories of error.
• An open-ended payload, to which arbitrary data can be attached.
• The “cause”, of this error, if it has not been lost to serialization.
• Various debugging information, such as a backtrace and spantrace (which is lost over serialization).

Implementations

impl Error

pub fn new<E>(origin: Origin, kind: Kind, cause: E) -> Selfwhere
    E: Into<Box<dyn Error + Send + Sync>>,

Construct a new error given ErrorCodes and a cause.

pub fn new_unknown<E>(origin: Origin, cause: E) -> Selfwhere
    E: Into<Box<dyn Error + Send + Sync>>,

Construct a new error with “unknown” error codes.

This ideally should not be used inside Ockam.

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

Construct a new error without an apparent cause

This constructor should be used for any error occurring because of a None unwrap.

pub fn code(&self) -> ErrorCode

Return the codes that identify this error.

pub fn context(self, key: &str, val: impl Display) -> Self

Attach additional unstructured information to the error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

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

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn ErrorTrait + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl<E> From<Error<E>> for Errorwhere
    E: Error + Send + Sync + 'static,

fn from(e: Error<E>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<RouteError> for Error

fn from(err: RouteError) -> Self

Converts to this type from the input type.

impl Serialize for Error

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

Serialize this value into the given Serde serializer.