Trait WebSocketConnection 

pub trait WebSocketConnection: WasmCompatSend + WasmCompatSync {
    // Required methods
    fn send(
        &mut self,
        frame: Frame,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>;
    fn recv(
        &mut self,
    ) -> Pin<Box<dyn Future<Output = Result<Option<Frame>, Error>> + Send + '_>>;
    fn close(
        &mut self,
        frame: Option<CloseFrame>,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>;
}

Available on crate feature websocket only.

One open websocket connection, usable as a trait object. Calls are sequential: sessions must not poll send and receive concurrently. WASM-compatible bounds preserve the containing session’s thread-safety contract.

Required Methods

fn send( &mut self, frame: Frame, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Write one frame.

fn recv( &mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<Frame>, Error>> + Send + '_>>

Read the next frame; Ok(None) means the peer ended the stream.

fn close( &mut self, frame: Option<CloseFrame>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Completes a close handshake. Callers must avoid repeated closes; backends may return an error for an already closed socket.

Trait Implementations

impl WebSocketConnection for Box<dyn WebSocketConnection>

fn send( &mut self, frame: Frame, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Write one frame.

fn recv( &mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<Frame>, Error>> + Send + '_>>

Read the next frame; Ok(None) means the peer ended the stream.

fn close( &mut self, frame: Option<CloseFrame>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Completes a close handshake. Callers must avoid repeated closes; backends may return an error for an already closed socket.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl WebSocketConnection for Box<dyn WebSocketConnection>

fn send( &mut self, frame: Frame, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

fn recv( &mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<Frame>, Error>> + Send + '_>>

fn close( &mut self, frame: Option<CloseFrame>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + '_>>

Implementors