Enum 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)

WebSocket(E)

IO(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)>

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

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

fn from(source: Error) -> Self

Converts to this type from the input type.

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

fn from(source: ParseError) -> Self

Converts to this type from the input 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.