Struct DecodeSettings 

pub struct DecodeSettings {
    pub resolve_palette_indices: bool,
    pub strict: bool,
    pub target_resolution: Option<(u32, u32)>,
}

Settings to apply during decoding.

Fields

resolve_palette_indices: bool

Whether palette indices should be resolved.

JPEG2000 images can be stored in two different ways. First, by storing RGB values (depending on the color space) for each pixel. Secondly, by only storing a single index for each channel, and then resolving the actual color using the index.

If you disable this option, in case you have an image with palette indices, they will not be resolved, but instead a grayscale image will be returned, with each pixel value corresponding to the palette index of the location.

strict: bool

Whether strict mode should be enabled when decoding.

The default is strict. Lenient mode is limited to the recoveries listed on DecodeSettings::lenient; it never relaxes codestream, bounds, overflow, allocation, or resource-limit validation.

target_resolution: Option<(u32, u32)>

A hint for the target resolution that the image should be decoded at.

Implementations

impl DecodeSettings

pub const fn lenient() -> Self

Compatibility settings for explicitly recoverable JP2/JPH metadata.

Lenient mode may:

• ignore a malformed trailing top-level box after the required image header and codestream boxes were parsed;
• ignore a malformed trailing child box after the required ihdr and colr boxes were parsed;
• ignore a malformed optional cdef or pclr box, preserving any earlier complete value; and
• infer an undeclared alpha channel when an otherwise consistent JP2 color declaration has exactly one extra codestream component.

Raw codestream validation and entropy decoding remain strict. Bounds, integer-overflow, allocation, and resource-limit checks are identical in both modes.

pub const fn strict() -> Self

Strict decode settings for fail-closed validation.

pub const fn lenient_tolerance_enabled(&self) -> bool

Whether the settings permit lenient tolerance of malformed optional metadata.

Trait Implementations

impl Clone for DecodeSettings

fn clone(&self) -> DecodeSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeSettings

impl Debug for DecodeSettings

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

Formats the value using the given formatter.

impl Default for DecodeSettings

fn default() -> Self

Returns the “default value” for a type.