Struct async_tungstenite::WebSocketStream

pub struct WebSocketStream<S> {
    pub(crate) inner: WebSocket<AllowStd<S>>,
    pub(crate) closing: bool,
    pub(crate) ended: bool,
    pub(crate) ready: bool,
}

A wrapper around an underlying raw stream which implements the WebSocket protocol.

A WebSocketStream<S> represents a handshake that has been completed successfully and both the server and the client are ready for receiving and sending data. Message from a WebSocketStream<S> are accessible through the respective Stream and Sink. Check more information about them in futures-rs crate documentation or have a look on the examples and unit tests for this crate.

Fields

inner: WebSocket<AllowStd<S>>

closing: bool

ended: bool

ready: bool

Tungstenite is probably ready to receive more data.

false once start_send hits WouldBlock errors. true initially and after flushing.

Implementations

impl<S> WebSocketStream<S>

pub async fn from_raw_socket( stream: S, role: Role, config: Option<WebSocketConfig>, ) -> Self

where S: AsyncRead + AsyncWrite + Unpin,

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

pub async fn from_partially_read( stream: S, part: Vec<u8>, role: Role, config: Option<WebSocketConfig>, ) -> Self

where S: AsyncRead + AsyncWrite + Unpin,

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

pub(crate) fn new(ws: WebSocket<AllowStd<S>>) -> Self

pub(crate) fn with_context<F, R>( &mut self, ctx: Option<(ContextWaker, &mut Context<'_>)>, f: F, ) -> R

where S: Unpin, F: FnOnce(&mut WebSocket<AllowStd<S>>) -> R, AllowStd<S>: Read + Write,

pub fn get_ref(&self) -> &S

where S: AsyncRead + AsyncWrite + Unpin,

Returns a shared reference to the inner stream.

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

where S: AsyncRead + AsyncWrite + Unpin,

Returns a mutable reference to the inner stream.

pub fn get_config(&self) -> &WebSocketConfig

Returns a reference to the configuration of the tungstenite stream.

pub async fn close( &mut self, msg: Option<CloseFrame<'_>>, ) -> Result<(), WsError>

where S: AsyncRead + AsyncWrite + Unpin,

Close the underlying web socket

Trait Implementations

impl<S: Debug> Debug for WebSocketStream<S>

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

Formats the value using the given formatter.

impl<T> FusedStream for WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T> Sink<Message> for WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T> Stream for WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

type Item = Result<Message, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.