Enum EncodeError 

#[non_exhaustive]
pub enum EncodeError {
    InvalidInput {
        what: &'static str,
    },
    Unsupported {
        what: &'static str,
    },
    ArithmeticOverflow {
        what: &'static str,
    },
    AllocationTooLarge {
        what: &'static str,
        requested: usize,
        cap: usize,
    },
    HostAllocationFailed {
        what: &'static str,
        bytes: usize,
    },
    Accelerator {
        operation: &'static str,
        source: J2kEncodeStageError,
    },
    CodestreamValidation {
        detail: &'static str,
    },
    InternalInvariant {
        what: &'static str,
    },
}

Error returned by native JPEG 2000 and HTJ2K encode operations.

The variants deliberately keep resource failures distinct from malformed requests, accelerator failures, and generated-codestream validation. This lets facade and transcode callers preserve actionable failure categories without parsing display strings.

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.

InvalidInput

Caller-provided samples, geometry, metadata, or options are invalid.

Fields

what: &'static str

Stable description of the invalid condition.

Unsupported

The requested encode feature or shape is not implemented.

Fields

what: &'static str

Stable description of the unsupported condition.

ArithmeticOverflow

Checked arithmetic overflowed while planning an encode phase.

Fields

what: &'static str

Name of the value or phase whose size overflowed.

AllocationTooLarge

Simultaneously live host allocations would exceed the shared cap.

Fields

what: &'static str

Name of the encode phase being checked.

requested: usize

Checked requested live host bytes at the rejected allocation boundary.

cap: usize

Maximum permitted live host bytes.

HostAllocationFailed

The allocator could not reserve a checked, cap-valid host allocation.

Fields

what: &'static str

Name of the allocation that failed.

bytes: usize

Requested allocation bytes, saturated on element-size overflow.

Accelerator

An optional encode-stage accelerator accepted work but failed it.

Fields

operation: &'static str

Encode-stage operation that failed.

source: J2kEncodeStageError

Structured stage failure with an optional concrete backend source.

CodestreamValidation

A generated codestream failed the requested validation contract.

Fields

detail: &'static str

Stable validation failure detail.

InternalInvariant

Internal encode state violated an invariant.

Fields

what: &'static str

Stable description of the violated invariant.

Trait Implementations

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, f: &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: &EncodeError) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncodeError