Enum WebSocketState

enum WebSocketState {
    Active,
    ClosedByUs,
    ClosedByPeer,
    CloseAcknowledged,
    Terminated,
}

The current connection state.

Variants

Active

The connection is active.

ClosedByUs

We initiated a close handshake.

ClosedByPeer

The peer initiated a close handshake.

CloseAcknowledged

The peer replied to our close handshake.

Terminated

The connection does not exist anymore.

Implementations

impl WebSocketState

fn is_active(self) -> bool

Tell if we’re allowed to process normal messages.

fn can_read(self) -> bool

Tell if we should process incoming data. Note that if we send a close frame but the remote hasn’t confirmed, they might have sent data before they receive our close frame, so we should still pass those to client code, hence ClosedByUs is valid.

fn check_not_terminated(self) -> Result<()>

Check if the state is active, return error if not.

Trait Implementations

impl Clone for WebSocketState

fn clone(&self) -> WebSocketState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketState

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

Formats the value using the given formatter.

impl PartialEq for WebSocketState

fn eq(&self, other: &WebSocketState) -> 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 WebSocketState

impl Eq for WebSocketState

impl StructuralPartialEq for WebSocketState