Struct TransportError 

#[non_exhaustive]
pub struct TransportError {
    pub code: Code,
    pub frame: Option<FrameType>,
    pub reason: Cow<'static, str>,
    pub cause: Option<ArcError>,
}

Available on crate feature quic only.

Transport-level errors occur when a peer violates the protocol specification

Note

The PartialEq implementation for this type performs comparison on the code field only

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: Code

Type of error

frame: Option<FrameType>

Frame type that triggered the error

reason: Cow<'static, str>

Human-readable explanation of the reason, which is what goes on the wire in CONNECTION_CLOSE. A literal is borrowed for the life of the program and costs nothing; text built at the point of failure is owned. Local diagnostics live in cause and never reach the peer.

cause: Option<ArcError>

An underlying TLS or local runtime failure, shared: this error is cloned for every stream, waiter and close reason that reports it, and the cause is rarely cloneable.

Implementations

impl Error

pub fn with_cause(self, cause: impl Error + Send + Sync + 'static) -> Error

Preserve a local failure underlying a transport shutdown.

pub fn new(code: Code, reason: impl Into<Cow<'static, str>>) -> Error

Construct an error with a code and a reason

pub fn code(&self) -> Code

What kind of error this is, as RFC 9000 §20 numbers them.

pub fn frame_type(&self) -> Option<FrameType>

The frame that caused it, when one did.

pub fn reason(&self) -> &str

The reason as it goes to the peer, empty when none was given.

pub fn cause(&self) -> Option<&ArcError>

The local underlying error, when this one came from another. It stays local: CONNECTION_CLOSE carries Self::code, Self::frame_type and Self::reason, and nothing of this.

impl Error

pub fn NO_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn INTERNAL_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn CONNECTION_REFUSED<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn FLOW_CONTROL_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn STREAM_LIMIT_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn STREAM_STATE_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn FINAL_SIZE_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn FRAME_ENCODING_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn TRANSPORT_PARAMETER_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn CONNECTION_ID_LIMIT_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn PROTOCOL_VIOLATION<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn INVALID_TOKEN<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn APPLICATION_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn CRYPTO_BUFFER_EXCEEDED<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn KEY_UPDATE_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn AEAD_LIMIT_REACHED<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn NO_VIABLE_PATH<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

pub fn VERSION_NEGOTIATION_ERROR<T>(reason: T) -> Error

where T: Into<Cow<'static, str>>,

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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 Eq for Error

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<Code> for Error

fn from(x: Code) -> Error

Converts to this type from the input type.

impl From<Error> for Close

fn from(x: Error) -> Close

Converts to this type from the input type.

impl From<Error> for ConnectionClose

fn from(x: Error) -> ConnectionClose

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 ConnectionError

fn from(value: Error) -> ConnectionError

Converts to this type from the input type.

impl From<InvalidFrame> for Error

fn from(err: InvalidFrame) -> Error

Converts to this type from the input type.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.