Enum Error

#[non_exhaustive]
pub enum Error {
    #[non_exhaustive]
    Closed {
        initiator: Location,
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    Transport {
        code: Code,
        frame_type: u64,
        reason: &'static str,
        initiator: Location,
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    Application {
        error: Error,
        initiator: Location,
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    StatelessReset {
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    IdleTimerExpired {
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    NoValidPath {
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    StreamIdExhausted {
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    MaxHandshakeDurationExceeded {
        max_handshake_duration: Duration,
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    ImmediateClose {
        reason: &'static str,
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    EndpointClosing {
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    InvalidConfiguration {
        reason: &'static str,
        source: &'static Location<'static>,
    },
    #[non_exhaustive]
    Unspecified {
        source: &'static Location<'static>,
    },
}

Errors that a connection can encounter.

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.

Closed

The connection was closed without an error

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

initiator: Location

source: &'static Location<'static>

Transport

The connection was closed on the transport level

This can occur either locally or by the peer. The argument contains the error code which the transport provided in order to close the connection.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

code: Code

frame_type: u64

reason: &'static str

initiator: Location

source: &'static Location<'static>

Application

The connection was closed on the application level

This can occur either locally or by the peer. The argument contains the error code which the application/ supplied in order to close the connection.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

error: Error

initiator: Location

source: &'static Location<'static>

StatelessReset

The connection was reset by a stateless reset from the peer

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: &'static Location<'static>

IdleTimerExpired

The connection was closed because the local connection’s idle timer expired

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: &'static Location<'static>

NoValidPath

The connection was closed because there are no valid paths

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: &'static Location<'static>

StreamIdExhausted

All Stream IDs for Streams on the given connection had been exhausted

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: &'static Location<'static>

MaxHandshakeDurationExceeded

The handshake has taken longer to complete than the configured max handshake duration

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

max_handshake_duration: Duration

source: &'static Location<'static>

ImmediateClose

The connection should be closed immediately without notifying the peer

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

reason: &'static str

source: &'static Location<'static>

EndpointClosing

The connection attempt was rejected because the endpoint is closing

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: &'static Location<'static>

InvalidConfiguration

The connection was closed due to invalid Application provided configuration

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

reason: &'static str

source: &'static Location<'static>

Unspecified

The connection was closed due to an unspecified reason

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

source: &'static Location<'static>

Implementations

impl Error

pub fn source(&self) -> &'static Location<'static>

Returns the panic::Location for the error

Trait Implementations

impl AsVariant for Error

const VARIANTS: &'static [Variant]

fn variant_idx(&self) -> usize

fn as_variant(&self) -> &'static Variant

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns 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>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<ConnectionClose<'_>> for Error

fn from(error: ConnectionClose<'_>) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Error

Converts to this type from the input type.

impl From<Error> for StreamError

fn from(error: Error) -> StreamError

Converts to this type from the input type.

impl IntoEvent<Error> for Error

fn into_event(self) -> Error

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryInto for Error

fn application_error(&self) -> Option<Error>

Returns the associated Error, if any

impl Copy for Error

impl Eq for Error