Struct ockam::Error

source · [−]

pub struct Error(_);

Expand description

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) -> Error where
E: Into<Box<dyn Error + Send + Sync + 'static, Global>>,

Construct a new error given ErrorCodes and a cause.

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

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) -> Error

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) -> Error

Attach additional unstructured informaton to the error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for Error

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

Formats the value using the given formatter. Read more

impl Error for Error

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

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

1.0.0 · source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · source

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

Provides type based access to context intended for error reports. Read more

impl From<AbacError> for Error

fn from(e: AbacError) -> Error

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Error

Converts to this type from the input type.

impl From<IdentityError> for Error

fn from(err: IdentityError) -> Error

Converts to this type from the input type.

impl From<OckamError> for Error

fn from(err: OckamError) -> Error

Converts to this type from the input type.

impl From<RouteError> for Error

fn from(err: RouteError) -> Error

Converts to this type from the input type.

impl From<SecureChannelError> for Error

fn from(e: SecureChannelError) -> Error

Converts to this type from the input type.

impl From<TransportError> for Error

fn from(err: TransportError) -> Error

Converts to this type from the input type.

impl From<VaultError> for Error

fn from(err: VaultError) -> Error

Converts to this type from the input type.

impl From<XXError> for Error

fn from(err: XXError) -> Error

Converts to this type from the input type.

impl Serialize for Error

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. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl !UnwindSafe for Error

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Decodable for T where
T: DeserializeOwned,

fn decode(encoded: &[u8]) -> Result<T, Error>

Decode a slice.

impl<T> Encodable for T where
T: Serialize,

fn encode(&self) -> Result<Vec<u8, Global>, Error>

Encode the type into an Encoded type.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<E> InstrumentError for E where
TracedError<E>: From<E>,

type Instrumented = TracedError<E>

The type of the wrapped error after instrumentation

fn in_current_span(self) -> <E as InstrumentError>::Instrumented

Instrument an Error by bundling it with a SpanTrace Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,