Enum SessionState 

pub enum SessionState {
    Uninitialised,
    Initialising,
    Operating,
    Closing,
    Closed,
    Stateless,
}

Where a session is in its lifecycle.

Variants

Uninitialised

A connection exists; no handshake has been offered.

Initialising

A handshake was accepted and answered; the peer has not confirmed it.

Operating

The handshake completed. Ordinary work is admitted.

Closing

A close was asked for. In-flight work is being drained; nothing new is admitted.

Closed

Finished. Terminal.

Stateless

No handshake at all: every message negotiates for itself and the session retains nothing between them.

Implementations

impl SessionState

pub const fn admits_ordinary_work(self) -> bool

Whether ordinary work — anything that is not part of the handshake — may be dispatched in this state.

The gate a lifecycle is asked to refine, not replace: a protocol narrows this further for its own methods, but the engine refuses everything in a closing or closed session regardless of what any lifecycle says.

pub const fn is_stateless(self) -> bool

Whether the session retains nothing between messages.

pub const fn is_terminal(self) -> bool

Whether no further transition is possible.

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

The state name, for messages and event logs.

Trait Implementations

impl Clone for SessionState

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 SessionState

impl Debug for SessionState

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

Formats the value using the given formatter.

impl Display for SessionState

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

Formats the value using the given formatter.

impl Eq for SessionState

impl Hash for SessionState

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 Ord for SessionState

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SessionState

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SessionState

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SessionState