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 lenient for compatibility with older releases. Lenient mode may tolerate malformed optional container metadata that strict mode rejects. Use DecodeSettings::strict for fail-closed validation of public or adversarial inputs.

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 decode settings.

Lenient mode keeps the historical behavior of accepting recoverable optional metadata problems where possible.

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.