Enum VideoDecodeError 

#[non_exhaustive]
pub enum VideoDecodeError {
    Decode(Error),
    Convert(ConvertError),
    PostCommitNeverResynced(PostCommitNeverResynced),
}

Error type for [FfmpegVideoStreamDecoder] — faults and the send-side refusal.

Every arm here is something that went wrong or something the push face declined. The drain’s needs input and ended are Received states out of receive_frame; they used to arrive as Decode(Ffmpeg(Other { errno: EAGAIN })) and Decode(Ffmpeg(Eof)), which is to say they had no name at this tier at all. Self::PostCommitNeverResynced is the deliberate exception on the end-of-stream road: it is not “the stream ended”, it is “the stream ended and the tail was lost”, which is a fault.

Open fault taxonomy, so it is #[non_exhaustive]. New ways to fail are discovered — a backend, a ceiling, a corruption a codec learns to report — and a consumer that meets one it has never heard of should take its generic-fault path. That is exactly what the wildcard arm this attribute forces is for. The two status vocabularies opposite it, Sent and Received, are exhaustive for the mirror-image reason: their arms are the substrate’s fixed state set, and there the wildcard would be dead weight hiding a state a consumer forgot.

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.

Decode(Error)

The wrapped decoder (HW or SW) reported an error.

Convert(ConvertError)

Frame conversion from FFmpeg’s native types to mediadecode’s types failed.

PostCommitNeverResynced(PostCommitNeverResynced)

A post-commit HW->SW fallback degraded the stream but the software decoder reached EOF without ever producing a frame.

Implementations

impl VideoDecodeError

pub const fn is_decode(&self) -> bool

Returns true if this value is of type Decode. Returns false otherwise

pub const fn is_convert(&self) -> bool

Returns true if this value is of type Convert. Returns false otherwise

pub const fn is_post_commit_never_resynced(&self) -> bool

Returns true if this value is of type PostCommitNeverResynced. Returns false otherwise

impl VideoDecodeError

pub fn unwrap_decode(self) -> Error

Unwraps this value to the VideoDecodeError::Decode variant. Panics if this value is of any other type.

pub fn unwrap_decode_ref(&self) -> &Error

Unwraps this reference to the VideoDecodeError::Decode variant. Panics if this value is of any other type.

pub fn unwrap_decode_mut(&mut self) -> &mut Error

Unwraps this mutable reference to the VideoDecodeError::Decode variant. Panics if this value is of any other type.

pub fn unwrap_convert(self) -> ConvertError

Unwraps this value to the VideoDecodeError::Convert variant. Panics if this value is of any other type.

pub fn unwrap_convert_ref(&self) -> &ConvertError

Unwraps this reference to the VideoDecodeError::Convert variant. Panics if this value is of any other type.

pub fn unwrap_convert_mut(&mut self) -> &mut ConvertError

Unwraps this mutable reference to the VideoDecodeError::Convert variant. Panics if this value is of any other type.

pub fn unwrap_post_commit_never_resynced(self) -> PostCommitNeverResynced

Unwraps this value to the VideoDecodeError::PostCommitNeverResynced variant. Panics if this value is of any other type.

pub fn unwrap_post_commit_never_resynced_ref(&self) -> &PostCommitNeverResynced

Unwraps this reference to the VideoDecodeError::PostCommitNeverResynced variant. Panics if this value is of any other type.

pub fn unwrap_post_commit_never_resynced_mut( &mut self, ) -> &mut PostCommitNeverResynced

Unwraps this mutable reference to the VideoDecodeError::PostCommitNeverResynced variant. Panics if this value is of any other type.

impl VideoDecodeError

pub fn try_unwrap_decode(self) -> Result<Error, TryUnwrapError<Self>>

Attempts to unwrap this value to the VideoDecodeError::Decode variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_decode_ref(&self) -> Result<&Error, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the VideoDecodeError::Decode variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_decode_mut( &mut self, ) -> Result<&mut Error, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the VideoDecodeError::Decode variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_convert(self) -> Result<ConvertError, TryUnwrapError<Self>>

Attempts to unwrap this value to the VideoDecodeError::Convert variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_convert_ref( &self, ) -> Result<&ConvertError, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the VideoDecodeError::Convert variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_convert_mut( &mut self, ) -> Result<&mut ConvertError, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the VideoDecodeError::Convert variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_post_commit_never_resynced( self, ) -> Result<PostCommitNeverResynced, TryUnwrapError<Self>>

Attempts to unwrap this value to the VideoDecodeError::PostCommitNeverResynced variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_post_commit_never_resynced_ref( &self, ) -> Result<&PostCommitNeverResynced, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the VideoDecodeError::PostCommitNeverResynced variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_post_commit_never_resynced_mut( &mut self, ) -> Result<&mut PostCommitNeverResynced, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the VideoDecodeError::PostCommitNeverResynced variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Trait Implementations

impl Debug for VideoDecodeError

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

Formats the value using the given formatter.

impl Display for VideoDecodeError

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

Formats the value using the given formatter.

impl Error for VideoDecodeError

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<ConvertError> for VideoDecodeError

fn from(source: ConvertError) -> Self

Converts to this type from the input type.

impl From<Error> for VideoDecodeError

fn from(source: Error) -> Self

Converts to this type from the input type.