Struct CloseHandshake 

pub struct CloseHandshake { /* private fields */ }

Close handshake state machine.

Tracks the state of the WebSocket close handshake and provides methods for transitioning through the handshake phases.

Implementations

impl CloseHandshake

pub fn new() -> Self

Create a new close handshake tracker.

pub fn with_config(config: CloseConfig) -> Self

Create with custom configuration.

pub const fn state(&self) -> CloseState

Get the current state.

pub const fn is_open(&self) -> bool

Check if the connection is open.

pub const fn is_closed(&self) -> bool

Check if the close handshake is complete.

pub fn our_reason(&self) -> Option<&CloseReason>

Get our close reason (if we initiated).

pub fn peer_reason(&self) -> Option<&CloseReason>

Get peer’s close reason (if they initiated).

pub const fn close_timeout(&self) -> Duration

Get the close timeout.

pub fn initiate(&mut self, reason: CloseReason) -> Option<Frame>

Initiate a close handshake.

Returns the close frame to send, or None if already closing/closed.

State Transitions

• Open → CloseSent: Returns close frame
• CloseReceived → Closed: Returns close frame (response)
• CloseSent | Closed: Returns None

pub fn receive_close(&mut self, frame: &Frame) -> Result<Option<Frame>, WsError>

Handle a received close frame.

Returns the close frame to send in response, or None if no response needed.

State Transitions

• Open → CloseReceived: Stores peer reason, returns response frame
• CloseSent → Closed: Stores peer reason, returns None (handshake complete)
• CloseReceived | Closed: Returns None (duplicate/unexpected)

pub fn force_close(&mut self, reason: CloseReason)

Force transition to closed state.

Use this when the connection is terminated without proper handshake (timeout, error, etc.).

Trait Implementations

impl Debug for CloseHandshake

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

Formats the value using the given formatter.

impl Default for CloseHandshake

fn default() -> Self

Returns the “default value” for a type.