Enum ErrorContext

pub enum ErrorContext {
    Custom(String),
    BuiltIn {
        for_type: &'static str,
    },
    WebSocket {
        source: Box<Self>,
    },
    WebSocketSink,
    WebSocketStream,
    DefaultImpl,
    Derived {
        for_type: &'static str,
    },
    EnumDiscrim {
        source: Box<Self>,
    },
    UnnamedField {
        idx: usize,
        source: Box<Self>,
    },
    NamedField {
        name: &'static str,
        source: Box<Self>,
    },
    FromStr,
    AsString {
        source: Box<Self>,
    },
    TryInto,
    Via {
        source: Box<Self>,
    },
    Bitflags {
        source: Box<Self>,
    },
}

Provides additional information about the origin of an error.

Variants

Custom(String)

An error context you can use when manually implementing Protocol.

BuiltIn

The error was produced by a Protocol implementation defined in the async-proto crate.

Fields

for_type: &'static str

The name of the type whose Protocol implementation produced the error.

Typically does not include type parameters.

WebSocket

The error occurred while reading/writing a WebSocket message.

Fields

source: Box<Self>

The context of the error returned from the message’s Protocol implementation.

WebSocketSink

The error was produced by a sink returned from async_proto::websocket021 and async_proto::websocket024.

WebSocketStream

The error was produced by a stream returned from async_proto::websocket021 and async_proto::websocket024.

DefaultImpl

The error was produced by the default implementation of a Protocol trait method.

Derived

The error was produced by an automatically derived Protocol implementation.

Fields

for_type: &'static str

The name of the type whose Protocol implementation produced the error.

EnumDiscrim

The error occurred while reading/writing the discriminant of an enum.

Fields

source: Box<Self>

The context of the error returned from the discriminant type’s Protocol implementation.

UnnamedField

The error occurred while reading/writing a field of a tuple, tuple struct, or tuple enum variant.

Fields

idx: usize

The position of the field, starting at 0.

source: Box<Self>

The context of the error returned from the field’s Protocol implementation.

NamedField

The error occurred while reading/writing a field of a struct or struct enum variant.

Fields

name: &'static str

The name of the field.

source: Box<Self>

The context of the error returned from the field’s Protocol implementation.

FromStr

The error occurred in the FromStr implementation of a type whose Protocol implementation was derived with #[async_proto(as_string)].

AsString

The error occurred while reading/writing a string representing a type whose Protocol implementation was derived with #[async_proto(as_string)].

Fields

source: Box<Self>

The context of the error returned from String’s Protocol implementation.

TryInto

The error occurred in the TryInto implementation for a type whose Protocol implementation was derived with #[async_proto(via = ...)].

Via

The error occurred while reading/writing a proxy type representing a type whose Protocol implementation was derived with #[async_proto(via ...)].

Fields

source: Box<Self>

The context of the error returned from the proxy type’s Protocol implementation.

Bitflags

The error was produced by the async_proto::bitflags macro.

Fields

source: Box<Self>

The context of the error returned from the bits type’s Protocol implementation.

Trait Implementations

impl Debug for ErrorContext

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

Formats the value using the given formatter.