Enum JpegError 

#[non_exhaustive]
pub enum JpegError {
    Truncated {
        offset: usize,
        expected: usize,
    },
    InvalidMarker {
        offset: usize,
        marker: u8,
    },
    UnexpectedMarker {
        offset: usize,
        expected: MarkerKind,
        found: u8,
    },
    MissingMarker {
        marker: MarkerKind,
    },
    DuplicateMarker {
        offset: usize,
        marker: MarkerKind,
    },
    InvalidSegmentLength {
        offset: usize,
        marker: u8,
        length: u16,
    },
    ConflictingDuplicateTable {
        offset: usize,
        table: TableKind,
        id: u8,
    },
    ExpectedDimensionsRequired {
        offset: usize,
    },
    ConflictingExpectedDimensions {
        offset: usize,
        expected: (u16, u16),
        actual: (u16, u16),
    },
    InvalidJpegAssembly {
        offset: usize,
        reason: &'static str,
    },
    ConflictingDri {
        offset: usize,
        existing: u16,
        new: u16,
    },
    UnsupportedSof {
        marker: u8,
        reason: UnsupportedReason,
    },
    UnsupportedComponentCount {
        count: u8,
    },
    UnsupportedColorSpace {
        color_space: ColorSpace,
    },
    UnsupportedBitDepth {
        depth: u8,
    },
    UnsupportedPredictor {
        predictor: u8,
    },
    ZeroDimension {
        width: u16,
        height: u16,
    },
    DimensionOverflow {
        width: u32,
        height: u32,
    },
    InvalidSampling {
        component: u8,
        h: u8,
        v: u8,
    },
    MissingQuantTable {
        component: u8,
        table_id: u8,
    },
    MissingHuffmanTable {
        component: u8,
        class: u8,
        id: u8,
    },
    InvalidScanParameters {
        offset: usize,
        ss: u8,
        se: u8,
        ah: u8,
        al: u8,
    },
    UnknownScanComponent {
        offset: usize,
        component: u8,
    },
    DuplicateScanComponent {
        offset: usize,
        component: u8,
    },
    InvalidSequentialComponentSet {
        offset: usize,
        expected: u8,
        found: u8,
    },
    InvalidSequentialScanCount {
        sof: SofKind,
        count: u16,
    },
    HuffmanDecode {
        mcu: u32,
        reason: HuffmanFailure,
    },
    RestartMismatch {
        offset: usize,
        expected: u8,
        found: u8,
    },
    UnexpectedEoi {
        mcu_at: u32,
        mcu_total: u32,
    },
    CoefficientOverflow {
        mcu: u32,
        component: u8,
    },
    MemoryCapExceeded {
        requested: usize,
        cap: usize,
    },
    OutputBufferTooSmall {
        required: usize,
        provided: usize,
    },
    InvalidStride {
        stride: usize,
        row: usize,
    },
    RectOutOfBounds {
        rect: Rect,
        width: u32,
        height: u32,
    },
    DownscaleUnsupported {
        sof: SofKind,
    },
    ScanFragmentsOverlap {
        mcu: u32,
    },
    BuilderConflict {
        reason: BuilderConflictReason,
    },
    NotImplemented {
        sof: SofKind,
    },
    RowSinkAborted,
}

Fatal JPEG decode or API error.

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.

Truncated

Input ended before the requested bytes could be read.

Fields

offset: usize

Byte offset where decoding stopped.

expected: usize

Additional byte count required.

InvalidMarker

Marker byte is not legal in the current JPEG position.

Fields

offset: usize

Byte offset of the marker.

marker: u8

Raw marker byte following 0xff.

UnexpectedMarker

A different marker kind was required at this position.

Fields

offset: usize

Byte offset of the unexpected marker.

expected: MarkerKind

Marker kind expected by the parser.

found: u8

Raw marker byte that was found.

MissingMarker

Required marker was absent from the stream.

Fields

marker: MarkerKind

Missing marker kind.

DuplicateMarker

A marker appeared more than once where only one is legal.

Fields

offset: usize

Byte offset of the duplicate marker.

marker: MarkerKind

Duplicated marker kind.

InvalidSegmentLength

Marker segment length is invalid for the marker kind.

Fields

offset: usize

Byte offset of the segment.

marker: u8

Raw marker byte following 0xff.

length: u16

Declared segment length.

ConflictingDuplicateTable

Duplicate DQT/DHT table has different bytes from an earlier definition.

Fields

offset: usize

Byte offset of the conflicting table segment.

table: TableKind

Table class.

id: u8

Table id.

ExpectedDimensionsRequired

TIFF/NDPI metadata did not provide dimensions needed to repair a zero SOF.

Fields

offset: usize

Byte offset of the SOF marker.

ConflictingExpectedDimensions

Container-provided dimensions conflict with non-zero SOF dimensions.

Fields

offset: usize

Byte offset of the SOF marker.

expected: (u16, u16)

Expected dimensions supplied by the caller.

actual: (u16, u16)

Dimensions declared by the SOF marker.

InvalidJpegAssembly

TIFF/JPEGTables assembly cannot produce a valid JPEG interchange stream.

Fields

offset: usize

Byte offset of the assembly problem.

reason: &'static str

Static diagnostic reason.

ConflictingDri

Duplicate DRI marker conflicts with an earlier DRI value.

Fields

offset: usize

Byte offset of the conflicting DRI segment.

existing: u16

Existing non-zero restart interval.

new: u16

New non-zero restart interval.

UnsupportedSof

Unsupported SOF variant. Carries the raw marker byte (e.g. 0xC9 for arithmetic extended-sequential) so callers routing to a fallback decoder can distinguish FFC5 from FFC9 without relying on reason. SOF marker class is outside the decoder’s supported JPEG subset.

Fields

marker: u8

Raw SOF marker byte.

reason: UnsupportedReason

Unsupported feature category.

UnsupportedComponentCount

Component count is outside the supported range.

Fields

count: u8

Declared component count.

UnsupportedColorSpace

Color space cannot be produced by the requested decode path.

Fields

color_space: ColorSpace

Header-derived color space.

UnsupportedBitDepth

Sample precision is not supported by this decoder path.

Fields

depth: u8

Declared sample precision in bits.

UnsupportedPredictor

Lossless predictor selection is unsupported.

Fields

predictor: u8

Predictor value from the scan header.

ZeroDimension

SOF declares a zero width or height.

Fields

width: u16

Declared width.

height: u16

Declared height.

DimensionOverflow

Dimensions exceed this crate’s safe decode bounds.

Fields

width: u32

Declared width.

height: u32

Declared height.

InvalidSampling

Component sampling factors are outside the JPEG legal range.

Fields

component: u8

Component id.

h: u8

Horizontal sampling factor.

v: u8

Vertical sampling factor.

MissingQuantTable

Component references a quantization table that was not defined.

Fields

component: u8

Component id.

table_id: u8

Referenced quantization table id.

MissingHuffmanTable

Scan references a Huffman table that was not defined.

Fields

component: u8

Component id.

class: u8

Huffman table class.

id: u8

Huffman table id.

InvalidScanParameters

Scan spectral selection or approximation parameters are invalid.

Fields

offset: usize

Byte offset of the scan header.

ss: u8

Start of spectral selection.

se: u8

End of spectral selection.

ah: u8

Successive approximation high bit.

al: u8

Successive approximation low bit.

UnknownScanComponent

Scan references a component id not declared in the SOF.

Fields

offset: usize

Byte offset of the scan header.

component: u8

Unknown component id.

DuplicateScanComponent

Scan lists the same component more than once.

Fields

offset: usize

Byte offset of the scan header.

component: u8

Duplicated component id.

InvalidSequentialComponentSet

Sequential scan does not contain the expected component set.

Fields

offset: usize

Byte offset of the scan header.

expected: u8

Expected component count.

found: u8

Found component count.

InvalidSequentialScanCount

Sequential SOF contained an invalid number of scans.

Fields

sof: SofKind

SOF kind being decoded.

count: u16

Observed scan count.

HuffmanDecode

Huffman entropy decoding failed. mcu is the current MCU when the caller has MCU progress, or 0 for table/bitstream contexts that do not track image position.

Fields

mcu: u32

Current MCU index, or 0 when the decoder context has no MCU index.

reason: HuffmanFailure

Failure category.

RestartMismatch

Restart marker sequence did not match the expected RST index.

Fields

offset: usize

Byte offset of the marker.

expected: u8

Expected RST index.

found: u8

Found raw marker byte.

UnexpectedEoi

EOI was reached before all MCUs were decoded.

Fields

mcu_at: u32

MCU index where EOI was found.

mcu_total: u32

Total MCU count expected for the image.

CoefficientOverflow

Decoded coefficient exceeded the representable range.

Fields

mcu: u32

MCU index.

component: u8

Component index.

MemoryCapExceeded

Requested decode allocation exceeds the configured memory cap.

Fields

requested: usize

Requested byte count.

cap: usize

Configured byte cap.

OutputBufferTooSmall

Caller-provided output buffer is too small.

Fields

required: usize

Required byte count.

provided: usize

Provided byte count.

InvalidStride

Output stride is smaller than the decoded row size.

Fields

stride: usize

Caller-provided stride.

row: usize

Minimum row byte count.

RectOutOfBounds

Requested decode rectangle is outside image bounds.

Fields

rect: Rect

Requested rectangle.

width: u32

Image width in pixels.

height: u32

Image height in pixels.

DownscaleUnsupported

Requested downscale is not supported for the SOF kind.

Fields

sof: SofKind

SOF kind being decoded.

ScanFragmentsOverlap

Builder-provided scan fragments overlap in MCU space.

Fields

mcu: u32

First overlapping MCU index.

BuilderConflict

Decoder builder inputs conflict.

Fields

reason: BuilderConflictReason

Conflict category.

NotImplemented

Transient pre-1.0 gap: the SOF is parseable and may eventually be supported by the decoder, but the current release does not implement the requested shape yet. Distinct from UnsupportedSof because callers routing to a fallback decoder on is_unsupported() should NOT reroute streams that a newer version of j2k will decode natively.

Fields

sof: SofKind

SOF kind awaiting implementation.

RowSinkAborted

Row sink returned an error and aborted row-based decoding.

Implementations

impl JpegError

pub fn is_unsupported(&self) -> bool

True if the error is recoverable by routing to a different decoder — any Unsupported* variant.

pub fn is_truncated(&self) -> bool

True if the input was truncated — caller may retry with more bytes.

pub fn is_api_misuse(&self) -> bool

True if the error indicates caller misuse, not a decode failure.

pub fn is_not_implemented(&self) -> bool

True if the error is a transient “not yet implemented” gap — the stream is valid and will decode on a future j2k release, so callers should not reroute to a different decoder permanently. See Self::is_unsupported for errors that are permanent routing decisions.

pub fn offset(&self) -> Option<usize>

Byte offset where the error was detected in the input stream, if any.

Trait Implementations

impl Clone for JpegError

fn clone(&self) -> JpegError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodecError for JpegError

fn is_truncated(&self) -> bool

True when the error indicates truncated input.

fn is_not_implemented(&self) -> bool

True when the error indicates an unimplemented supported surface.

fn is_unsupported(&self) -> bool

True when the error indicates unsupported input or options.

fn is_buffer_error(&self) -> bool

True when the error indicates caller buffer sizing or layout problems.

impl Debug for JpegError

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

Formats the value using the given formatter.

impl Display for JpegError

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

Formats the value using the given formatter.

impl Eq for JpegError

impl Error for JpegError

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<JpegError> for FastPacketError

fn from(value: JpegError) -> Self

Converts to this type from the input type.

impl PartialEq for JpegError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JpegError