Enum EncodeError 

#[non_exhaustive]
pub enum EncodeError {
    Cancelled,
    InvalidTimestamp,
    Adapter(String),
    Output(String),
    OutputInUse(String),
    Publish {
        message: String,
        kept: Option<PathBuf>,
    },
    EncoderRejected {
        encoder: String,
        frame: u64,
        message: String,
    },
    Gpu {
        fault: GpuFault,
        message: String,
    },
    EncodersRefused {
        message: String,
        refusals: Vec<EncoderRefusal>,
    },
}

Typed encoding failure.

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.

Cancelled

The operation was cancelled; partial output must be removed by policy.

InvalidTimestamp

Input timestamps violated monotonic/interleave requirements.

Adapter(String)

Adapter failure without leaking a platform error type.

Output(String)

The output file could not be created or claimed. Nothing was encoded.

OutputInUse(String)

Another live export, in any process, holds the output’s partial file. Nothing was encoded.

Publish

The output was encoded but could not be moved to its final path. The finished file is kept beside the target under another name.

Fields

message: String

The target, the step that failed and the operating system’s error.

kept: Option<PathBuf>

Where the finished file is now; None when that move also failed.

EncoderRejected

The encoder refused an input frame on a still-usable device; another path may succeed.

Fields

encoder: String

The encoder that refused, as FFmpeg names it (h264_d3d12va).

frame: u64

The frame it refused, counted from 0 in the order frames were sent.

message: String

The encoder’s message and session state.

Gpu

A GPU call failed; message names the call and its platform status.

Fields

fault: GpuFault

What the status says about the device.

message: String

The failed call and its platform status.

EncodersRefused

No encoder candidate opened. Each refusal’s kind tells whether retrying can help.

Fields

message: String

Every candidate’s refusal, in the order they were tried.

refusals: Vec<EncoderRefusal>

The refusals themselves, most preferred candidate first.

Implementations

impl EncodeError

pub fn gpu_timeout(what: impl Display) -> Self

A timed-out GPU wait for what, carrying GPU_TIMEOUT_MESSAGE.

Trait Implementations

impl Clone for EncodeError

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 EncodeError

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

Formats the value using the given formatter.

impl Display for EncodeError

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

Formats the value using the given formatter.

impl Eq for EncodeError

impl Error for EncodeError

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 EncodeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncodeError