Enum ConnectionMode

#[repr(u8)]
pub enum ConnectionMode {
    Active = 0,
    Reconnect = 1,
    Disconnect = 2,
    Closed = 3,
}

Connection mode for a socket client.

The client can be in one of four modes (managed via an atomic flag).

Variants

Active = 0

The client is fully connected and operational. All tasks (reading, writing, heartbeat) are running normally.

Reconnect = 1

The client has been disconnected or has been explicitly signaled to reconnect. In this state, active tasks are paused until a new connection is established.

Disconnect = 2

The client has been explicitly signaled to disconnect. No further reconnection attempts will be made, and cleanup procedures are initiated.

Closed = 3

The client is permanently closed. All associated tasks have been terminated and the connection is no longer available.

Implementations

impl ConnectionMode

pub fn from_u8(value: u8) -> Self

Convert a u8 to ConnectionMode, useful when loading from an AtomicU8.

pub fn from_atomic(value: &AtomicU8) -> Self

pub const fn as_u8(self) -> u8

Convert a ConnectionMode to a u8, useful when storing to an AtomicU8.

pub fn is_active(&self) -> bool

Returns true if the client is in an active state.

pub fn is_reconnect(&self) -> bool

Returns true if the client is attempting to reconnect.

pub fn is_disconnect(&self) -> bool

Returns true if the client is attempting to disconnect.

pub fn is_closed(&self) -> bool

Returns true if the client connection is closed.

Trait Implementations

impl AsRef<str> for ConnectionMode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ConnectionMode

fn clone(&self) -> ConnectionMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionMode

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

Formats the value using the given formatter.

impl Default for ConnectionMode

fn default() -> ConnectionMode

Returns the “default value” for a type.

impl Display for ConnectionMode

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

Formats the value using the given formatter.

impl FromStr for ConnectionMode

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ConnectionMode, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ConnectionMode

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 ConnectionMode

fn eq(&self, other: &ConnectionMode) -> 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 TryFrom<&str> for ConnectionMode

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ConnectionMode, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for ConnectionMode

impl Eq for ConnectionMode

impl StructuralPartialEq for ConnectionMode