Struct WebSocketTransport

pub struct WebSocketTransport<S> { /* private fields */ }

A transport implementation that uses WebSocket protocol for communication.

This transport provides bidirectional communication over WebSocket protocol, supporting both secure (WSS) and standard (WS) connections.

Implementations

impl<S> WebSocketTransport<S>

where S: AsyncRead + AsyncWrite + Unpin + Send + Sync + 'static,

pub fn from_stream(stream: WebSocketStream<S>) -> Self

Creates a new WebSocket transport from an existing WebSocket stream. This is typically used on the server side when accepting a new connection.

Arguments

• stream - The WebSocket stream from an accepted connection

impl WebSocketTransport<MaybeTlsStream<TcpStream>>

pub async fn new(url: &str) -> Result<Self, Error>

Creates a new WebSocket transport as a client by connecting to the specified URL.

Arguments

• url - The WebSocket URL to connect to (ws:// or wss://)

Returns

Returns a Result containing:

• Ok: The new WebSocketTransport instance
• Err: An error if connection fails

Trait Implementations

impl<S> Transport for WebSocketTransport<S>

where S: AsyncRead + AsyncWrite + Unpin + Send + Sync + 'static,

fn send<'life0, 'async_trait>( &'life0 self, message: Message, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a message over the transport

fn receive(&self) -> Pin<Box<dyn Stream<Item = Result<Message, Error>> + Send>>

Receive messages from the transport

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close the transport