Skip to main content

DisconnectOrigin

Enum DisconnectOrigin 

Source
pub enum DisconnectOrigin {
    OnConnectAbort,
    Reading,
    Shutdown,
    User,
    Writing,
}
Expand description

Describes what triggered a disconnect, as delivered to Disconnect::handle_disconnect.

note: Handshake failures do not appear here. A failed handshake prevents the connection from ever being registered, so there is no connection to disconnect.

note: When several events would race to trigger a disconnect on the same connection, only the first to claim it is delivered to Disconnect::handle_disconnect; subsequent claims are silently dropped.

Variants§

§

OnConnectAbort

The OnConnect task terminated abnormally before defusing its connection cleanup. In practice this almost always means the user’s OnConnect::on_connect implementation panicked, and the disconnect is a side effect of that panic unwinding past the cleanup guard.

§

Reading

The reader task for this connection terminated. Typical causes are the peer closing its end of the socket, a decode error from the user-supplied Reading::Codec, or no message arriving within [Reading::IDLE_TIMEOUT_MS]. Often (but not always) indicates a peer-side issue.

§

Shutdown

The disconnect was initiated by Tcp::shut_down, which tears down every active connection as part of stopping the node. Unlike DisconnectOrigin::User, this signals that the entire node is going away - reconnection is not meaningful.

§

User

The disconnect was explicitly requested via Tcp::disconnect. This is the only origin produced directly by user code; the others all reflect events the library detected internally.

§

Writing

The writer task for this connection terminated. Typical causes are a [Writing::TIMEOUT_MS] timeout while flushing, an underlying socket write error, or the message channel being closed. Often correlates with the peer disappearing, but can also reflect local-side pipeline problems (slow consumer, broken pipe).

Trait Implementations§

Source§

impl Clone for DisconnectOrigin

Source§

fn clone(&self) -> DisconnectOrigin

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DisconnectOrigin

Source§

impl Debug for DisconnectOrigin

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DisconnectOrigin

Source§

impl Hash for DisconnectOrigin

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DisconnectOrigin

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DisconnectOrigin

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more