Enum HandshakeError 

#[non_exhaustive]
pub enum HandshakeError {
    Transport(Error),
    Core(HandshakeError),
    Timeout,
    StreamClosed,
    Disconnected,
    UnexpectedEvent(String),
}

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.

Transport(Error)

Core(HandshakeError)

Timeout

StreamClosed

Producer side of transport_events was dropped — distinct from a timeout because nothing more will ever arrive on the channel, regardless of how long we wait. Surfaced separately so callers can log it accurately and so retry policies that pace themselves on timeout don’t silently swallow a teardown.

Disconnected

UnexpectedEvent(String)

Implementations

impl HandshakeError

pub fn is_timeout(&self) -> bool

The handshake ran out of time, as opposed to being torn down.

Matched exhaustively so a new variant has to be classified here rather than defaulting to “not a timeout” unnoticed.

impl HandshakeError

pub fn is_transient(&self) -> bool

Transient errors that are expected during reconnect and will resolve on retry. These never invalidate the cached server static.

pub fn is_crypto_fatal(&self) -> bool

Crypto-fatal: a cached server static or cert chain is no longer trustworthy. The orchestration layer must clear the IK cache and fall back to XX on the next attempt.

Narrowed to the Core variants that actually point at a stale or poisoned cache. Programmer-side bugs (Proto encode failure, our own crypto provider misuse, HKDF impossible failure, counter exhaustion in a single handshake) are NOT crypto-fatal — they indicate a code defect, and clearing the cache would mask it. A stream-closed event during recv is treated as transient by is_transient, not here.

Trait Implementations

impl Debug for HandshakeError

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

Formats the value using the given formatter.

impl Display for HandshakeError

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

Formats the value using the given formatter.

impl Error for HandshakeError

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<HandshakeError> for ConnectError

fn from(source: HandshakeError) -> Self

Converts to this type from the input type.

impl From<HandshakeError> for HandshakeError

fn from(source: CoreHandshakeError) -> Self

Converts to this type from the input type.