Struct WsStream

pub struct WsStream { /* private fields */ }

A futures 0.3 Sink/Stream of WsMessage. Created with WsMeta::connect.

Closing the connection

When this is dropped, the connection closes, but you should favor calling one of the close methods on WsMeta, which allow you to set a proper close code and reason.

Since this implements Sink, it has to have a close method. This method will call the web api WebSocket.close without parameters. Eg. a default value of 1005 will be assumed for the close code. The situation is the same when dropping without calling close.

Warning: This object holds the callbacks needed to receive events from the browser. If you drop it before the close event was emitted, you will no longer receive events. Thus, observers will never receive a Close event. Drop will issue a Closing event and this will be the very last event observers receive. The the stream will end if WsMeta is also dropped.

See the integration tests if you need an example.

Implementations

impl WsStream

pub fn ready_state(&self) -> Result<WsState, WsErr>

Verify the WsState of the connection.

pub fn wrapped(&self) -> &WebSocket

Access the wrapped web_sys::WebSocket directly.

ws_stream_wasm tries to expose all useful functionality through an idiomatic rust API, so hopefully you won’t need this, however if I missed something, you can.

Caveats

If you call set_onopen, set_onerror, set_onmessage or set_onclose on this, you will overwrite the event listeners from ws_stream_wasm, and things will break.

pub fn into_io(self) -> IoStream<WsStreamIo, Vec<u8>>

Wrap this object in IoStream. IoStream implements AsyncRead/AsyncWrite/AsyncBufRead. Beware: that this will transparenty include text messages as bytes.

Trait Implementations

impl Debug for WsStream

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

Formats the value using the given formatter.

impl Drop for WsStream

fn drop(&mut self)

Executes the destructor for this type.

impl Sink<WsMessage> for WsStream

type Error = WsErr

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: WsMessage) -> 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>, _: &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 Stream for WsStream

type Item = Result<WsMessage, WsErr>

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.