Enum ws_stream_wasm::WsEvent

pub enum WsEvent {
    Open,
    Error,
    Closing,
    Closed(CloseEvent),
}

Events related to the WebSocket. You can filter like:

use
{
  ws_stream_wasm       :: *                        ,
  pharos               :: *                        ,
  wasm_bindgen         :: UnwrapThrowExt           ,
  wasm_bindgen_futures :: futures_0_3::spawn_local ,
  futures              :: stream::StreamExt        ,
};

let program = async
{
  let (mut ws, _wsio) = WsStream::connect( "127.0.0.1:3012", None ).await

     .expect_throw( "assume the connection succeeds" );

  // The Filter type comes from the pharos crate.
  //
  let mut evts = ws.observe( Filter::Pointer( WsEvent::is_closed ).into() );

  ws.close().await;

  // Note we will only get the closed event here, the WsEvent::Closing has been filtered out.
  //
  assert!( evts.next().await.unwrap_throw().is_closed () );
};

spawn_local( program );

Variants

Open

The connection is now Open

Error

An error happened on the connection. For more information about when this event occurs, see the HTML Living Standard.

Closing

The connection has started closing, but is not closed yet.

Closed(CloseEvent)

The connection was closed. This enclosed CloseEvent has some extra information.

Methods

impl WsEvent

pub fn is_open(&self) -> bool

Predicate indicating whether this is a WsEvent::Open event. Can be used as a filter for the event stream obtained with [WsStream::observe].

pub fn is_err(&self) -> bool

Predicate indicating whether this is a WsEvent::Error event. Can be used as a filter for the event stream obtained with [WsStream::observe].

pub fn is_closing(&self) -> bool

Predicate indicating whether this is a WsEvent::Closing event. Can be used as a filter for the event stream obtained with [WsStream::observe].

pub fn is_closed(&self) -> bool

Predicate indicating whether this is a WsEvent::Closed event. Can be used as a filter for the event stream obtained with [WsStream::observe].

Trait Implementations

impl Eq for WsEvent

impl Clone for WsEvent

fn clone(&self) -> WsEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<WsEvent> for WsEvent

fn eq(&self, other: &WsEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WsEvent) -> bool

This method tests for !=.

impl Debug for WsEvent

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

Formats the value using the given formatter.

impl Observable<WsEvent> for WsStream

type Error = Error

The error type that is returned if observing is not possible.

fn observe(
    &mut self,
    options: ObserveConfig<WsEvent>
) -> Result<Events<WsEvent>, Self::Error>

Add an observer to the observable. Options allow chosing the channel type and to filter events with a predicate.