Enum DisconnectReason 

pub enum DisconnectReason {
    HostNotAllowedToConnect,
    ProtocolError,
    KeyExchangeFailed,
    Reserved,
    MacError,
    CompressionError,
    ServiceNotAvailable,
    ProtocolVersionNotSupported,
    HostKeyNotVerifiable,
    ConnectionLost,
    ByApplication,
    TooManyConnections,
    AuthCancelledByUser,
    NoMoreAuthMethodsAvailable,
    IllegalUserName,
    Other(u32),
}

Set of possible disconnection reasons.

Variants

HostNotAllowedToConnect

Standard RFC4253 disconnect reason.

ProtocolError

Standard RFC4253 disconnect reason.

KeyExchangeFailed

Standard RFC4253 disconnect reason.

Reserved

Standard RFC4253 disconnect reason.

MacError

Standard RFC4253 disconnect reason.

CompressionError

Standard RFC4253 disconnect reason.

ServiceNotAvailable

Standard RFC4253 disconnect reason.

ProtocolVersionNotSupported

Standard RFC4253 disconnect reason.

HostKeyNotVerifiable

Standard RFC4253 disconnect reason.

ConnectionLost

Standard RFC4253 disconnect reason.

ByApplication

Standard RFC4253 disconnect reason.

TooManyConnections

Standard RFC4253 disconnect reason.

AuthCancelledByUser

Standard RFC4253 disconnect reason.

NoMoreAuthMethodsAvailable

Standard RFC4253 disconnect reason.

IllegalUserName

Standard RFC4253 disconnect reason.

Other(u32)

Some other disconnect reason.

Implementations

impl DisconnectReason

pub fn decode_with(reader: &mut ObjectReader<'_>) -> Result<Self, ProtocolError>

Decodes an instance of this type from an object reader.

pub fn encode_with( self, writer: &mut ObjectWriter<'_>, ) -> Result<(), ProtocolError>

Encodes this instance into an object writer.

pub fn into_reason_code(self) -> u32

Retrieves the underlying reason code.

pub fn from_reason_code(reason_code: u32) -> Self

Constructs an instance of this type from a reason code.

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

Retrieves a description message for this disconnect reason instance.

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 PartialEq for DisconnectReason

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DisconnectReason

impl Eq for DisconnectReason

impl StructuralPartialEq for DisconnectReason