Enum sophia_api::quad::stream::StreamError

pub enum StreamError<SourceErr, SinkErr> where
    SourceErr: 'static + Error,
    SinkErr: 'static + Error,  {
    SourceError(SourceErr),
    SinkError(SinkErr),
}

A error that is raised by functions that move fallible Sources into fallible Sinks.

In case this error is raised it can be matched to investigate if Source or Sink failed.

Conversion

Both variants SourceError and SinkError are public exported. Consequently, StreamError can be constructed with .map_err(SourceError) and .map_err(SinkError).

ToDo

For a proper use in multi-threaded environments the trait bounds should be supplied with + Send + Sync. However, such bounds wound make StreamError incompatible with sophia’s whole error-handling. This should be resolved when the error-handling is completely refactored (tracking issue).

Variants

SourceError(SourceErr)

Tuple Fields

0: SourceErr

SinkError(SinkErr)

Tuple Fields

0: SinkErr

Implementations

impl<SourceErr, SinkErr> StreamError<SourceErr, SinkErr> where
    SourceErr: 'static + Error,
    SinkErr: 'static + Error, 

pub fn is_source_error(&self) -> bool

Checks if StreamError was raised by the Source.

pub fn is_sink_error(&self) -> bool

Checks if StreamError was raised by the Sink.

pub fn inner_into<Err>(self) -> Err where
    SourceErr: 'static + Error + Into<Err>,
    SinkErr: 'static + Error + Into<Err>, 

Converts StreamError into an inner error.

pub fn unwrap_source_error(self) -> SourceErr

Unwrap as the inner SourceError.

Panic

Panic if self is actually a SinkError.

pub fn unwrap_sink_error(self) -> SinkErr

Unwrap as the inner SinkError.

Panic

Panic if self is actually a SourceError.

pub fn reverse(self) -> StreamError<SinkErr, SourceErr>

Switch source and sink error.

Trait Implementations

impl<SourceErr: Debug, SinkErr: Debug> Debug for StreamError<SourceErr, SinkErr> where
    SourceErr: 'static + Error,
    SinkErr: 'static + Error, 

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

Formats the value using the given formatter.

impl<SourceErr, SinkErr> Display for StreamError<SourceErr, SinkErr> where
    SourceErr: 'static + Error,
    SinkErr: 'static + Error,
    SourceErr: Display,
    SinkErr: Display, 

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

Formats the value using the given formatter.

impl<SourceErr, SinkErr> Error for StreamError<SourceErr, SinkErr> where
    SourceErr: 'static + Error,
    SinkErr: 'static + Error,
    SourceErr: Error + 'static,
    SinkErr: Error + 'static,
    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