Enum EngineError 

#[non_exhaustive]
pub enum EngineError {
    Evaluate(EvalError),
    Render(RenderError),
    InvalidQualityProfile,
    OutOfRange,
    EmptyExportRange,
    ExportTooLarge {
        frames: u64,
        maximum: u64,
    },
    Text(TextError),
    InvalidAudioConfiguration,
    InvalidNormalizationGain,
    UnregisteredEffect {
        effect: String,
        version: u32,
    },
    ExportProjectChanged,
    OddExportDimensions {
        width: u32,
        height: u32,
        suggested: (u32, u32),
    },
}

Failure produced by an engine runner.

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.

Evaluate(EvalError)

Timeline evaluation failed.

Render(RenderError)

GPU rendering failed.

InvalidQualityProfile

A quality profile contains an unusable value.

OutOfRange

A frame index or scaled output size cannot be represented.

EmptyExportRange

An exporter requires a non-empty timeline interval.

ExportTooLarge

An export schedule exceeds the bounded frame budget.

Fields

frames: u64

Requested frame count.

maximum: u64

Largest supported frame count.

Text(TextError)

A caption or a text generator could not be rasterized or uploaded.

InvalidAudioConfiguration

An audio renderer received an unsupported layout, rate, or block size.

InvalidNormalizationGain

A loudness normalization gain is not finite, or its linear factor is not a finite, positive 32-bit float.

UnregisteredEffect

The project draws an effect the renderer has not registered, or whose registration failed.

Fields

effect: String

The effect’s id.

version: u32

Its version.

ExportProjectChanged

An export step was given another snapshot than the one its exporter was made for.

OddExportDimensions

A 4:2:0 export was asked for an output with an odd width or height.

Its chroma planes are half size, and H.264 and HEVC crop in two-pixel steps, so the bitstream cannot carry an odd size. The project canvas may be odd; making the output even is the host’s choice.

Fields

width: u32

Output width.

height: u32

Output height.

suggested: (u32, u32)

The nearest even size, each odd dimension one pixel smaller (larger for a one-pixel dimension).

Implementations

impl EngineError

pub fn code(&self) -> ErrorCode

This failure’s protocol code.

Trait Implementations

impl Clone for EngineError

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 EngineError

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

Formats the value using the given formatter.

impl Display for EngineError

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

Formats the value using the given formatter.

impl Eq for EngineError

impl Error for EngineError

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<EvalError> for EngineError

fn from(error: EvalError) -> Self

Converts to this type from the input type.

impl From<RenderError> for EngineError

fn from(error: RenderError) -> Self

Converts to this type from the input type.

impl PartialEq for EngineError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EngineError