Enum DisconnectReason 

#[non_exhaustive]
pub enum DisconnectReason {
    Shutdown,
    Restart,
    Other(String),
}

Reason for service disconnection.

Wire forward-compatibility

Other(String) is a catch-all for reason strings received from a newer peer that this build does not yet recognise. Serde deserialization is infallible: an unknown string becomes Other(...) rather than a parse error, allowing rolling upgrades without dropping the Disconnecting message.

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.

Shutdown

SIGTERM/SIGINT - clean exit.

Restart

SIGHUP - will reconnect after external restart.

Other(String)

An unknown reason received from a newer peer.

The inner string is the raw snake_case value as it appeared on the wire.

Implementations

impl DisconnectReason

pub fn as_str(&self) -> &str

Returns the string representation.

For DisconnectReason::Other, returns the inner string as-is.

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<'de> Deserialize<'de> for DisconnectReason

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for DisconnectReason

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

Formats the value using the given formatter.

impl Eq for DisconnectReason

impl From<String> for DisconnectReason

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for DisconnectReason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DisconnectReason

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DisconnectReason