Enum CloseReason 

#[non_exhaustive]
pub enum CloseReason {
    PeerClosed,
    PeerReset,
    Idle,
    HandshakeTimeout,
    ReadTimeout,
    WriteTimeout,
    ExchangeDeadline,
    ParkDeadline,
    SlowPeer {
        direction: Direction,
    },
    Refused(RefusalCause),
    ProxyUntrusted,
    ProxyMissing,
    ProxyInvalid,
    TlsFailed,
    HelloRefused,
    Killed(KillReason),
    EgressDenied(u16),
    Drained,
    DrainDeadline,
    Shed,
    Shutdown,
    SessionClosed,
    SessionError,
    SessionPanicked,
    Limit(LimitKind),
    Io(OsErrorClass),
}

Why a connection closed. Every connection ends with exactly one.

Examples

use net_io::{CloseReason, Direction};
let reason = CloseReason::SlowPeer { direction: Direction::In };
assert_eq!(reason.as_str(), "slow_peer_in");
assert!(reason.is_abortive());
assert!(!CloseReason::PeerClosed.is_abortive());

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.

PeerClosed

The peer closed its side and the session closed.

PeerReset

The peer sent RST.

Idle

No exchange started within the idle timeout.

HandshakeTimeout

The PROXY header and TLS handshake did not finish within the handshake timeout.

ReadTimeout

No progress within the read timeout.

WriteTimeout

No progress within the write timeout.

ExchangeDeadline

The session’s deadline for the current exchange passed.

ParkDeadline

A parked connection was not woken in time.

SlowPeer

The minimum transfer rate was not met.

Fields

direction: Direction

In which direction.

Refused(RefusalCause)

Refused at accept or by the session factory.

ProxyUntrusted

A PROXY-required listener got a connection from an untrusted peer.

ProxyMissing

A trusted peer sent no PROXY header.

ProxyInvalid

The PROXY header was malformed or too large.

TlsFailed

The TLS engine failed.

HelloRefused

The TLS engine’s hello hook refused the ClientHello.

Killed(KillReason)

A kill handle closed the connection.

EgressDenied(u16)

The gate denied a write.

Drained

The session finished after drain started.

DrainDeadline

The session had not finished when the drain deadline passed.

Shed

The control line shed this lane.

Shutdown

The control line said Stopping, or the server shut down.

SessionClosed

The session returned Step::Close.

SessionError

The session returned Step::Abort, or a handler returned an error.

SessionPanicked

The session panicked.

Limit(LimitKind)

A per-connection bound was hit.

Io(OsErrorClass)

The OS reported an error not covered above.

Implementations

impl CloseReason

pub fn as_str(&self) -> &'static str

A stable snake_case name for logs.

assert_eq!(net_io::CloseReason::Idle.as_str(), "idle");

pub fn is_abortive(&self) -> bool

Whether the connection is closed with RST (true) or gracefully with FIN (false).

assert!(net_io::CloseReason::ReadTimeout.is_abortive());

Trait Implementations

impl Clone for CloseReason

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CloseReason

impl Debug for CloseReason

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

Formats the value using the given formatter.

impl Display for CloseReason

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

Formats the value using the given formatter.

impl Eq for CloseReason

impl Hash for CloseReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CloseReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CloseReason