Struct Decoder

pub struct Decoder { /* private fields */ }

Read an image with custom settings

Implementations

impl Decoder

pub fn new() -> Self

pub fn info_raw(&self) -> &ColorMode

pub fn info_raw_mut(&mut self) -> &mut ColorMode

Preferred color mode for decoding

pub fn info_png(&self) -> &Info

Actual color mode of the decoded image or inspected file

pub fn info_png_mut(&mut self) -> &mut Info

pub fn color_convert(&mut self, true_or_false: bool)

whether to convert the PNG to the color type you want. Default: yes

pub fn read_text_chunks(&mut self, true_or_false: bool)

if false but remember_unknown_chunks is true, they’re stored in the unknown chunks.

pub fn remember_unknown_chunks(&mut self, true_or_false: bool)

store all bytes from unknown chunks in the Info (off by default, useful for a png editor)

pub fn get_icc(&self) -> Result<Vec<u8>, Error>

Decompress ICC profile from iCCP chunk. Only available if remember_unknown_chunks was set.

pub fn decode<Bytes: AsRef<[u8]>>( &mut self, input: Bytes, ) -> Result<Image, Error>

Load PNG from buffer using Decoder’s settings

state.info_raw_mut().colortype = ColorType::RGBA;
match state.decode(&slice) {
    Ok(Image::RGBA(with_alpha)) => do_stuff(with_alpha),
    _ => panic!("¯\\_(ツ)_/¯")
}

pub fn decode_file<P: AsRef<Path>>( &mut self, filepath: P, ) -> Result<Image, Error>

Decode a file from disk using Decoder’s settings

pub fn inspect(&mut self, input: &[u8]) -> Result<(usize, usize), Error>

Updates info_png. Returns (width, height)

pub fn set_custom_zlib( &mut self, callback: custom_decompress_callback, context: *const c_void, )

use custom zlib decoder instead of built in one

pub fn set_custom_inflate( &mut self, callback: custom_decompress_callback, context: *const c_void, )

use custom deflate decoder instead of built in one.

If custom_zlib is used, custom_inflate is ignored since only the built in zlib function will call custom_inflate

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Decoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decoder

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

Formats the value using the given formatter.

impl Default for Decoder

fn default() -> Decoder

Returns the “default value” for a type.