Enum DisconnectReason 

#[non_exhaustive]
pub enum DisconnectReason {
    Eof,
    Reset(ErrorKind),
    Requested,
    WriteClosed,
}

Why a connection ended.

Every variant is “expected” in the sense that a peer is always allowed to go away; they are kept distinct so a consumer can log or react differently (for example, treating DisconnectReason::Requested as fully graceful).

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.

Eof

The stream reached end of file (the peer closed its side cleanly).

Reset(ErrorKind)

The peer reset the connection abruptly (ConnectionReset, BrokenPipe, ConnectionAborted, …). Routine for clients such as Home Assistant.

Requested

The peer sent a DisconnectRequest and we completed the graceful disconnect handshake.

WriteClosed

The write half of the connection stopped while the read half was still processing, so a reply could no longer be delivered.

Trait Implementations

impl Clone for DisconnectReason

fn clone(&self) -> DisconnectReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisconnectReason

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

Formats the value using the given formatter.

impl Display for DisconnectReason

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

Formats the value using the given formatter.

impl Error for DisconnectReason

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.