Struct IcnsDecoder 

pub struct IcnsDecoder<R> { /* private fields */ }

ICNS decoder

Implementations

impl<R> IcnsDecoder<R>

where R: Read + Seek,

pub fn new(reader: R) -> Result<IcnsDecoder<R>, ImageError>

Create a new IcnsDecoder and seek around the input file to locate the “best” image. (“best” here means largest, breaking ties to prefer higher total bit depth; if still tied the earliest image is chosen.)

The resulting decoder does not support decoding Jpeg2000 image entries. Use [IcnsDecoder::new_with_decode_funcs] if you’d like to supply your own function for that.

pub fn new_with_decode_func( reader: R, jp2: SubformatDecodeFn, ) -> Result<IcnsDecoder<R>, ImageError>

Create a new IcnsDecoder and seek around the input file to locate the “best” image. (“best” here means largest, breaking ties to prefer higher total bit depth; if still tied the earliest image is chosen.)

The ICNS format can nest PNG and JP2 images; this function accepts a function that can be used to decode the JP2 images. See for example unsupported_jpeg2000, and decode_jpeg2000_using_hook.

Trait Implementations

impl<R: Read + Seek> ImageDecoder for IcnsDecoder<R>

fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

fn set_limits(&mut self, limits: Limits) -> ImageResult<()>

Set the decoder to have the specified limits. See Limits for the different kinds of limits that is possible to set.

fn read_image(self, buf: &mut [u8]) -> ImageResult<()>

Returns all the bytes in the image.

fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()>

Use read_image instead; this method is an implementation detail needed so the trait can be object safe.

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

fn icc_profile(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the ICC color profile embedded in the image, or Ok(None) if the image does not have one.

fn exif_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw Exif chunk, if it is present. A third-party crate such as kamadak-exif is required to actually parse it.

fn xmp_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw XMP chunk, if it is present. A third-party crate such as roxmltree is required to actually parse it.

fn iptc_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw IPTC chunk, if it is present.

fn orientation(&mut self) -> Result<Orientation, ImageError>

Returns the orientation of the image.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.