Struct oxipng::Options

pub struct Options {

    pub fix_errors: bool,
    pub force: bool,
    pub filter: IndexSet<RowFilter>,
    pub interlace: Option<Interlacing>,
    pub optimize_alpha: bool,
    pub bit_depth_reduction: bool,
    pub color_type_reduction: bool,
    pub palette_reduction: bool,
    pub grayscale_reduction: bool,
    pub idat_recoding: bool,
    pub scale_16: bool,
    pub strip: StripChunks,
    pub deflate: Deflaters,
    pub fast_evaluation: bool,
    pub timeout: Option<Duration>,
}

Options controlling the output of the optimize function

Fields

fix_errors: bool

Attempt to fix errors when decoding the input file rather than returning an Err.

Default: false

force: bool

Write to output even if there was no improvement in compression.

Default: false

filter: IndexSet<RowFilter>

Which RowFilters to try on the file

Default: None,Sub,Entropy,Bigrams

interlace: Option<Interlacing>

Whether to change the interlacing type of the file.

None will not change the current interlacing type.

Some(x) will change the file to interlacing mode x.

Default: Some(Interlacing::None)

optimize_alpha: bool

Whether to allow transparent pixels to be altered to improve compression.

bit_depth_reduction: bool

Whether to attempt bit depth reduction

Default: true

color_type_reduction: bool

Whether to attempt color type reduction

Default: true

palette_reduction: bool

Whether to attempt palette reduction

Default: true

grayscale_reduction: bool

Whether to attempt grayscale reduction

Default: true

idat_recoding: bool

Whether to perform recoding of IDAT and other compressed chunks

If any type of reduction is performed, IDAT recoding will be performed regardless of this setting

Default: true

scale_16: bool

Whether to forcibly reduce 16-bit to 8-bit by scaling

Default: false

strip: StripChunks

Which chunks to strip from the PNG file, if any

Default: None

deflate: Deflaters

Which DEFLATE algorithm to use

Default: Libdeflater

fast_evaluation: bool

Whether to use fast evaluation to pick the best filter

Default: true

timeout: Option<Duration>

Maximum amount of time to spend on optimizations. Further potential optimizations are skipped if the timeout is exceeded.

Implementations

impl Options

pub fn from_preset(level: u8) -> Options

pub fn max_compression() -> Options

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.