Enum bililive_core::errors::StreamError

pub enum StreamError<E> {
    Parse(ParseError),
    WebSocket(E),
    IO(Error),
}

Errors that may occur when consuming a stream.

E is determined by the underlying websocket implementation.

Variants

Parse(ParseError)

Tuple Fields of Parse

0: ParseError

WebSocket(E)

Tuple Fields of WebSocket

0: E

IO(Error)

Tuple Fields of IO

0: Error

Implementations

impl<E> StreamError<E>

pub const fn from_ws_error(e: E) -> Self

Trait Implementations

impl<E: Debug> Debug for StreamError<E>

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

Formats the value using the given formatter.

impl<E> Display for StreamError<E> where
    E: Display, 

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

Formats the value using the given formatter.

impl<E> Error for StreamError<E> where
    Self: Debug + Display, 

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<E> From<Error> for StreamError<E>

fn from(source: Error) -> Self

Performs the conversion.

impl<E> From<ParseError> for StreamError<E>

fn from(source: ParseError) -> Self

Performs the conversion.

impl<T, E> UnderlyingStream<RetryContext, Result<Packet, StreamError<E>>, StreamError<E>> for WsStream<T, E> where
    T: WsStreamTrait<E>,
    E: Error, 

type Stream = T::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.