Enum ws_stream_wasm::WsEvent

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

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) = WsMeta::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 and ready for use.

Error

An error happened on the connection. For more information about when this event occurs, see the HTML Living Standard. Since the browser is not allowed to convey any information to the client code as to why an error happened (for security reasons), as described in the HTML specification, there usually is no extra information available. That's why this event has no data attached to it.

Closing

The connection has started closing, but is not closed yet. You shouldn't try to send messages over it anymore. Trying to do so will result in an error.

Closed(CloseEvent)

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

WsErr(WsErr)

An error happened, not on the connection, but inside ws_stream_wasm. This currently happens when an incoming message can not be converted to Rust types, eg. a String message with invalid encoding.

Implementations

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 pharos::Observable::observe on WsMeta.

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 pharos::Observable::observe on WsMeta.

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 pharos::Observable::observe on WsMeta.

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 pharos::Observable::observe on WsMeta.

pub fn is_ws_err(&self) -> bool

Predicate indicating whether this is a WsEvent::WsErr event. Can be used as a filter for the event stream obtained with pharos::Observable::observe on WsMeta.

Trait Implementations

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 Debug for WsEvent

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

Formats the value using the given formatter.

impl Eq for WsEvent

impl Observable<WsEvent> for WsMeta

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.

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 StructuralEq for WsEvent

impl StructuralPartialEq for WsEvent