Struct image::codecs::png::PngDecoder

source ·
pub struct PngDecoder<R: Read> { /* private fields */ }
Expand description

PNG decoder

Implementations§

source§

impl<R: Read> PngDecoder<R>

source

pub fn new(r: R) -> ImageResult<PngDecoder<R>>

Creates a new decoder that decodes from the stream r

source

pub fn with_limits(r: R, limits: Limits) -> ImageResult<PngDecoder<R>>

Creates a new decoder that decodes from the stream r with the given limits.

source

pub fn gamma_value(&self) -> ImageResult<Option<f64>>

Returns the gamma value of the image or None if no gamma value is indicated.

If an sRGB chunk is present this method returns a gamma value of 0.45455 and ignores the value in the gAMA chunk. This is the recommended behavior according to the PNG standard:

When the sRGB chunk is present, […] decoders that recognize the sRGB chunk but are not capable of colour management are recommended to ignore the gAMA and cHRM chunks, and use the values given above as if they had appeared in gAMA and cHRM chunks.

source

pub fn apng(self) -> ApngDecoder<R>

Turn this into an iterator over the animation frames.

Reading the complete animation requires more memory than reading the data from the IDAT frame–multiple frame buffers need to be reserved at the same time. We further do not support compositing 16-bit colors. In any case this would be lossy as the interface of animation decoders does not support 16-bit colors.

If something is not supported or a limit is violated then the decoding step that requires them will fail and an error will be returned instead of the frame. No further frames will be returned.

source

pub fn is_apng(&self) -> bool

Returns if the image contains an animation.

Note that the file itself decides if the default image is considered to be part of the animation. When it is not the common interpretation is to use it as a thumbnail.

If a non-animated image is converted into an ApngDecoder then its iterator is empty.

Trait Implementations§

source§

impl<'a, R: 'a + Read> ImageDecoder<'a> for PngDecoder<R>

§

type Reader = PngReader<R>

The type of reader produced by into_reader.
source§

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

Returns a tuple containing the width and height of the image
source§

fn color_type(&self) -> ColorType

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

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

Returns the ICC color profile embedded in the image Read more
source§

fn into_reader(self) -> ImageResult<Self::Reader>

👎Deprecated: Planned for removal. See https://github.com/image-rs/image/issues/1989
Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least scanline_bytes from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering.
source§

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

Returns all the bytes in the image. Read more
source§

fn scanline_bytes(&self) -> u64

👎Deprecated: Planned for removal. See https://github.com/image-rs/image/issues/1989
Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().
source§

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

Set decoding limits for this decoder. See Limits for the different kinds of limits that is possible to set. Read more
source§

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding
source§

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image. Read more
source§

fn read_image_with_progress<F: Fn(Progress)>( self, buf: &mut [u8], progress_callback: F, ) -> ImageResult<()>

👎Deprecated: Use read_image instead. See https://github.com/image-rs/image/issues/1989
Same as read_image but periodically calls the provided callback to give updates on loading progress.

Auto Trait Implementations§

§

impl<R> Freeze for PngDecoder<R>
where R: Freeze,

§

impl<R> !RefUnwindSafe for PngDecoder<R>

§

impl<R> Send for PngDecoder<R>
where R: Send,

§

impl<R> Sync for PngDecoder<R>
where R: Sync,

§

impl<R> Unpin for PngDecoder<R>
where R: Unpin,

§

impl<R> !UnwindSafe for PngDecoder<R>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.