Struct WsStream 

pub struct WsStream<T: WsStreamTrait<E>, E>(/* private fields */);

Wrapper for types implementing WsStreamTrait.

This type is used to avoid the orphan rule. Exposed for stream type construction.

Implementations

impl<T, E> WsStream<T, E>

where T: WsStreamTrait<E>,

pub async fn connect(url: &str) -> Result<T::Stream, E>

Connect to bilibili websocket server.

Errors

Returns an error when websocket connection fails.

Trait Implementations

impl<T: Debug + WsStreamTrait<E>, E: Debug> Debug for WsStream<T, E>

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

Formats the value using the given formatter.

impl<T: Default + WsStreamTrait<E>, E: Default> Default for WsStream<T, E>

fn default() -> WsStream<T, E>

Returns the “default value” for a type.

impl<T, E> UnderlyingStream<RetryContext, Result<Packet, StreamError<E>>, StreamError<E>> for WsStream<T, E>

where T: WsStreamTrait<E>, E: Error,

type Stream = <T as WsStreamTrait<E>>::Stream

fn establish( ctor_arg: RetryContext, ) -> Pin<Box<dyn Future<Output = Result<Self::Stream, StreamError<E>>>>>

The creation function is used by ReconnectStream in order to establish both the initial IO connection in addition to performing reconnects.

fn is_write_disconnect_error(err: &StreamError<E>) -> bool

When sink send experience an Error during operation, it does not necessarily mean it is a disconnect/termination (ex: WouldBlock). You may specify which errors are considered “disconnects” by this method.

fn is_read_disconnect_error(item: &Result<Packet, StreamError<E>>) -> bool

It’s common practice for Stream implementations that return an Err when there’s an error. You may match the result to tell them apart from normal response. By default, no response is considered a “disconnect”.

fn exhaust_err() -> StreamError<E>

This is returned when retry quota exhausted.