Enum HandshakeError 

#[non_exhaustive]
pub enum HandshakeError {
    NoData,
    InvalidMarker(u8),
    EncryptionProtocolMismatch(&'static str),
    MalformedFrame,
    MacFailure,
    Crypto(String),
    Aborted,
}

Failures while establishing a connection or performing the encryption handshake. All of these are returned before the read/write loops start.

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.

NoData

No bytes were received on a freshly accepted connection (for example, a port probe that connects and immediately closes).

InvalidMarker(u8)

The first byte was neither 0 (plaintext) nor 1 (encrypted).

EncryptionProtocolMismatch(&'static str)

The peer and this device disagree on transport encryption: one side offered plaintext while the other requires (or forbids) an encrypted connection. The contained string describes which side mismatched.

MalformedFrame

The peer sent a handshake frame that is too short to be valid.

MacFailure

The noise handshake failed its MAC check (wrong encryption key).

Crypto(String)

The noise handshake produced a cryptographic error while building our response. Unexpected; indicates a protocol or state problem rather than a peer disconnect.

Aborted

The peer went away mid-handshake, before it could complete.

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

fn from(source: HandshakeError) -> Self

Converts to this type from the input type.