Enum VTError 

#[non_exhaustive]
pub enum VTError {
    SessionCreateFailed(OSStatus),
    SetPropertyFailed {
        key: String,
        status: OSStatus,
    },
    PrepareFailed(OSStatus),
    EncodeFailed(OSStatus),
    CompleteFailed(OSStatus),
    PixelBufferCreateFailed(i32),
    EncoderCallback(OSStatus),
    ApiFailed {
        api: &'static str,
        status: OSStatus,
    },
    UnexpectedSampleCount {
        operation: &'static str,
        expected: usize,
        actual: i64,
    },
    TimedOut {
        operation: &'static str,
    },
    InvalidArgument(String),
    Unsupported {
        api: &'static str,
        minimum: &'static str,
    },
    CommandBuffer(CommandBufferError),
}

Top-level error returned by all fallible APIs in this crate.

Wraps Apple’s OSStatus and tags the call site so the user can tell “the encoder failed to create” apart from “the encoder rejected this frame”.

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.

SessionCreateFailed(OSStatus)

VTCompressionSessionCreate returned non-zero.

SetPropertyFailed

VTSessionSetProperty returned non-zero. The String identifies which property.

Fields

key: String

status: OSStatus

PrepareFailed(OSStatus)

VTCompressionSessionPrepareToEncodeFrames returned non-zero.

EncodeFailed(OSStatus)

VTCompressionSessionEncodeFrame returned non-zero.

CompleteFailed(OSStatus)

VTCompressionSessionCompleteFrames returned non-zero.

PixelBufferCreateFailed(i32)

CVPixelBufferCreateWithIOSurface returned non-zero or NULL.

EncoderCallback(OSStatus)

The user-supplied async callback reported a non-zero status when encoding a frame.

ApiFailed

A specific VideoToolbox / CoreVideo / CoreMedia API returned non-zero.

Fields

api: &'static str

status: OSStatus

UnexpectedSampleCount

A one-shot operation received a buffer containing an unsupported number of samples.

Fields

operation: &'static str

expected: usize

actual: i64

TimedOut

A bounded bridge operation did not finish before its deadline.

Fields

operation: &'static str

InvalidArgument(String)

An invalid argument was supplied (e.g. zero width).

Unsupported

Fields

api: &'static str

minimum: &'static str

CommandBuffer(CommandBufferError)

Available on crate feature frame_processor only.

Implementations

impl VTError

pub const fn status(&self) -> Option<OSStatus>

Underlying OSStatus if the error originated from a VT call.

Trait Implementations

impl Clone for VTError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VTError

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

Formats the value using the given formatter.

impl Display for VTError

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

Formats the value using the given formatter.

impl Eq for VTError

impl Error for VTError

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 PartialEq for VTError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VTError