Struct WebSocketStream 

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

Available on crate feature ws only.

A WebSocket stream that works with compio.

Implementations

impl<S> WebSocketStream<S>

pub fn get_ref(&self) -> &S

Get a reference to the underlying stream.

pub fn get_mut(&mut self) -> &mut S

Get a mutable reference to the underlying stream.

impl<S> WebSocketStream<S>

where S: AsyncRead + AsyncWrite,

pub async fn from_raw_socket( stream: S, role: Role, config: impl Into<Config>, ) -> WebSocketStream<S>

Convert a raw socket into a WebSocketStream without performing a handshake.

disable_nagle will be ignored since the socket is already connected and the user can set nodelay on the socket directly before calling this function if needed.

pub async fn from_partially_read( stream: S, part: Vec<u8>, role: Role, config: impl Into<Config>, ) -> WebSocketStream<S>

Convert a raw socket into a WebSocketStream without performing a handshake.

disable_nagle will be ignored since the socket is already connected and the user can set nodelay on the socket directly before calling this function if needed.

pub async fn send(&mut self, message: Message) -> Result<(), Error>

Send a message on the WebSocket stream.

pub async fn read(&mut self) -> Result<Message, Error>

Read a message from the WebSocket stream.

pub async fn flush(&mut self) -> Result<(), Error>

Flush the WebSocket stream.

pub async fn close( &mut self, close_frame: Option<CloseFrame>, ) -> Result<(), Error>

Close the WebSocket connection.

pub fn into_compat(self) -> CompatWebSocketStream<S>

where &'a S: for<'a> AsyncRead + for<'a> AsyncWrite, S: Unpin,

Available on crate feature io-compat only.

Convert this stream into a [futures_util] compatible stream.

Trait Implementations

impl<S> Debug for WebSocketStream<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> IntoInner for WebSocketStream<S>

type Inner = WebSocket<SyncStream<S>>

The inner type.

fn into_inner(self) -> <WebSocketStream<S> as IntoInner>::Inner

Get the inner buffer.