Enum SeaFileError 

#[non_exhaustive]
pub enum SeaFileError {
    Connect {
        target: String,
        source: Box<dyn StdError + Send + Sync>,
    },
    Subscribe {
        stream: String,
        source: Box<dyn StdError + Send + Sync>,
    },
    Receive {
        stream: String,
        source: Box<dyn StdError + Send + Sync>,
    },
    Publish {
        stream: String,
        source: Box<dyn StdError + Send + Sync>,
    },
    Seek {
        stream: String,
        source: Box<dyn StdError + Send + Sync>,
    },
    NotConnected,
    Invalid(String),
}

Errors returned by the file and stdio transports.

One enum for the whole crate, variants by source, per the RustStream broker conventions. The wrapped sources are boxed std errors so the public API does not leak the client’s error types.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Connect

Opening (or creating) the stream file, or attaching stdio, failed.

Fields

target: String

The file path or stdio.

source: Box<dyn StdError + Send + Sync>

The client’s failure.

Subscribe

Opening a subscription failed.

Fields

stream: String

The stream key the subscription targeted.

source: Box<dyn StdError + Send + Sync>

The client’s failure.

Receive

The transport failed while receiving.

Fields

stream: String

The stream key (or file) of the subscription.

source: Box<dyn StdError + Send + Sync>

The client’s failure.

Publish

Publishing failed.

Fields

stream: String

The stream key the message targeted.

source: Box<dyn StdError + Send + Sync>

The client’s failure.

Seek

Repositioning failed.

Fields

stream: String

The stream key of the subscription.

source: Box<dyn StdError + Send + Sync>

The client’s failure.

NotConnected

The handle is used before connect filled the shared state, or after shutdown.

Invalid(String)

A descriptor or payload is invalid for this transport.

Trait Implementations

impl Debug for SeaFileError

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

Formats the value using the given formatter.

impl Display for SeaFileError

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

Formats the value using the given formatter.

impl Error for SeaFileError

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.