Struct oxipng::Options

pub struct Options {

    pub backup: bool,
    pub fix_errors: bool,
    pub pretend: bool,
    pub force: bool,
    pub preserve_attrs: bool,
    pub filter: IndexSet<u8>,
    pub interlace: Option<u8>,
    pub alphas: IndexSet<AlphaOptim>,
    pub bit_depth_reduction: bool,
    pub color_type_reduction: bool,
    pub palette_reduction: bool,
    pub grayscale_reduction: bool,
    pub idat_recoding: bool,
    pub strip: Headers,
    pub deflate: Deflaters,
    pub use_heuristics: bool,
    pub timeout: Option<Duration>,
}

Options controlling the output of the optimize function

Fields

backup: bool

Whether the input file should be backed up before writing the output.

Default: false

fix_errors: bool

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

Default: false

pretend: bool

Don’t actually write any output, just calculate the best results.

Default: false

force: bool

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

Default: false

preserve_attrs: bool

Ensure the output file has the same permissions as the input file.

Default: false

filter: IndexSet<u8>

Which filters to try on the file (0-5)

Default: 0,5

interlace: Option<u8>

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: None

alphas: IndexSet<AlphaOptim>

Alpha filtering strategies to use

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 IDAT recoding

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

Default: true

strip: Headers

Which headers to strip from the PNG file, if any

Default: None

deflate: Deflaters

Which DEFLATE algorithm to use

Default: Zlib

use_heuristics: bool

Whether to use heuristics to pick the best filter and compression

Intended for use with -o 1 from the CLI interface

Default: false

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.