ws_stream_wasm 0.6.1

use crate::{ import::*, 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 );
///```
//
#[ derive( Clone, Debug, PartialEq, Eq ) ]
//
pub enum WsEvent
{
	/// The connection is now Open and ready for use.
	//
	Open,

	/// An error happened on the connection. For more information about when this event
	/// occurs, see the [HTML Living Standard](https://html.spec.whatwg.org/multipage/web-sockets.html).
	/// 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.
	//
	Error,

	/// 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.
	//
	Closing,

	/// The connection was closed. The enclosed [`CloseEvent`] has some extra information.
	//
	Closed( CloseEvent ),

	/// 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.
	//
	WsErr( WsErr )
}


impl WsEvent
{
	/// 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`](crate::WsMeta).
	//
	pub fn is_open( &self ) -> bool
	{
		match self
		{
			Self::Open => true,
			_          => false,
		}
	}

	/// 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`](crate::WsMeta).
	//
	pub fn is_err( &self ) -> bool
	{
		match self
		{
			Self::Error => true,
			_           => false,
		}
	}

	/// 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`](crate::WsMeta).
	//
	pub fn is_closing( &self ) -> bool
	{
		match self
		{
			Self::Closing => true,
			_             => false,
		}
	}

	/// 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`](crate::WsMeta).
	//
	pub fn is_closed( &self ) -> bool
	{
		match self
		{
			Self::Closed(_) => true,
			_               => false,
		}
	}

	/// 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`](crate::WsMeta).
	//
	pub fn is_ws_err( &self ) -> bool
	{
		match self
		{
			Self::WsErr(_) => true,
			_              => false,
		}
	}
}



/// An event holding information about how/why the connection was closed.
///
// We use this wrapper because the web_sys version isn't Send and pharos requires events
// to be Send.
//
#[ derive( Clone, Debug, PartialEq, Eq ) ]
//
pub struct CloseEvent
{
	/// The close code.
	/// See: [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close).
	//
	pub code: u16,

	/// The reason why the connection was closed.
	/// See: [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close).
	//
	pub reason: String,

	/// Whether the connection was closed cleanly.
	/// See: [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close).
	//
	pub was_clean: bool,
}


impl From<JsCloseEvt> for CloseEvent
{
	fn from( js_evt: JsCloseEvt ) -> Self
	{
		Self
		{
			code     : js_evt.code     () ,
			reason   : js_evt.reason   () ,
			was_clean: js_evt.was_clean() ,
		}
	}
}