Enum StreamError 

#[non_exhaustive]
pub enum StreamError {
    Protocol {
        kind: ProtocolErrorKind,
        detail: String,
    },
    Handshake(String),
    ConnectionClosed,
    StreamNotFound {
        app: String,
        stream_id: String,
    },
    AppNotFound(String),
    AppAlreadyRegistered(String),
    Unauthorized(String),
    StreamAlreadyPublishing {
        app: String,
        stream_id: String,
    },
    PublisherLimitReached {
        limit: usize,
    },
    UnsupportedCodec(String),
    Codec(String),
    Transcode(String),
    HwAccelUnavailable(String),
    Pipeline(String),
    Storage(String),
    StorageNotFound(String),
    Cluster(String),
    NodeNotFound(String),
    Config(String),
    Io(Error),
    Other(String),
}

The crate-wide error type returned by every fallible operation (see the Result alias). #[non_exhaustive], so matching must include a wildcard arm.

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.

Protocol

A wire-protocol failure, classified by ProtocolErrorKind.

Fields

kind: ProtocolErrorKind

What kind of protocol failure occurred.

detail: String

Human-readable detail for logs.

Handshake(String)

A protocol handshake did not complete successfully.

ConnectionClosed

The peer closed the connection before the operation finished.

StreamNotFound

No live stream matches the requested key in the given application.

Fields

app: String

Application name searched.

stream_id: String

Stream id searched.

AppNotFound(String)

No application is registered under this name.

AppAlreadyRegistered(String)

An application with this name is already registered.

Unauthorized(String)

Authorization denied for the attempted publish or play.

StreamAlreadyPublishing

A live publisher already holds this stream key.

Fields

app: String

Application name.

stream_id: String

Stream id already publishing.

PublisherLimitReached

The engine-wide concurrent-publisher cap was reached.

Fields

limit: usize

The configured cap that was hit.

UnsupportedCodec(String)

The codec is recognized but not supported by this build.

Codec(String)

A codec parse/bitstream error.

Transcode(String)

A transcoding pipeline error.

HwAccelUnavailable(String)

A requested hardware-acceleration backend is unavailable.

Pipeline(String)

A generic media-pipeline error.

Storage(String)

A storage-backend operation failed.

StorageNotFound(String)

The requested object does not exist in the storage backend.

Cluster(String)

A cluster/federation operation failed.

NodeNotFound(String)

No cluster node matches the requested address.

Config(String)

A configuration value was missing or invalid.

Io(Error)

An underlying I/O error (auto-converted via ?).

Other(String)

Anything not covered by a more specific variant.

Implementations

impl StreamError

pub fn protocol(msg: impl Into<String>) -> Self

A protocol error of unspecified ProtocolErrorKind::Other kind.

pub fn protocol_kind(kind: ProtocolErrorKind, msg: impl Into<String>) -> Self

A protocol error classified with an explicit ProtocolErrorKind.

pub fn codec(msg: impl Into<String>) -> Self

A Codec error.

pub fn transcode(msg: impl Into<String>) -> Self

A Transcode error.

pub fn storage(msg: impl Into<String>) -> Self

A Storage error.

pub fn cluster(msg: impl Into<String>) -> Self

A Cluster error.

pub fn config(msg: impl Into<String>) -> Self

A Config error.

pub fn other(msg: impl Into<String>) -> Self

An Other error.

Trait Implementations

impl Debug for StreamError

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

Formats the value using the given formatter.

impl Display for StreamError

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

Formats the value using the given formatter.

impl Error for StreamError

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 From<Error> for StreamError

fn from(source: Error) -> Self

Converts to this type from the input type.