Enum FrameError 

#[non_exhaustive]
pub enum FrameError {
    TooManyVideoPlanes(TooManyVideoPlanes),
    TooManyAudioPlanes(TooManyAudioPlanes),
    TooManyImagePlanes(TooManyImagePlanes),
}

Errors returned by the try_new constructors on the frame 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.

TooManyVideoPlanes(TooManyVideoPlanes)

VideoFrame::try_new was called with plane_count > 4. The fixed plane array has exactly 4 slots; plane_count values up to and including 4 are accepted, larger values would later panic inside VideoFrame::planes far from the construction site. See TooManyVideoPlanes for the payload details. #[from] gives a free impl From<TooManyVideoPlanes> for FrameError, so inner helpers that return Result<_, TooManyVideoPlanes> can be ?-propagated into FrameError directly.

TooManyAudioPlanes(TooManyAudioPlanes)

AudioFrame::try_new was called with plane_count > 8. The fixed plane array has exactly 8 slots (matches FFmpeg’s AV_NUM_DATA_POINTERS). See TooManyAudioPlanes for the payload details. #[from] gives a free impl From<TooManyAudioPlanes> for FrameError.

TooManyImagePlanes(TooManyImagePlanes)

ImageFrame::try_new was called with plane_count > 4. The fixed plane array has exactly 4 slots — the same cap the video household carries, and for the same reason: packed RGB is 1, MJPEG’s YUV is 3, and an alpha channel makes 4. See TooManyImagePlanes for the payload details. #[from] gives a free impl From<TooManyImagePlanes> for FrameError.

Implementations

impl FrameError

pub const fn is_too_many_video_planes(&self) -> bool

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

pub const fn is_too_many_audio_planes(&self) -> bool

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

pub const fn is_too_many_image_planes(&self) -> bool

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

Trait Implementations

impl Clone for FrameError

fn clone(&self) -> FrameError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for FrameError

impl Debug for FrameError

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

Formats the value using the given formatter.

impl Display for FrameError

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

Formats the value using the given formatter.

impl Eq for FrameError

impl Error for FrameError

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<TooManyAudioPlanes> for FrameError

fn from(source: TooManyAudioPlanes) -> Self

Converts to this type from the input type.

impl From<TooManyImagePlanes> for FrameError

fn from(source: TooManyImagePlanes) -> Self

Converts to this type from the input type.

impl From<TooManyVideoPlanes> for FrameError

fn from(source: TooManyVideoPlanes) -> Self

Converts to this type from the input type.

impl Hash for FrameError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FrameError

fn eq(&self, other: &FrameError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FrameError