Skip to main content

Decoder

Struct Decoder 

Source
pub struct Decoder { /* private fields */ }
Expand description

Decodes PNG files, with a configurable size limit.

use pltrs_codec::png::{self, ColorType, Decoder, ImageRef};

let gray = [0u8, 64, 128, 255];
let file = png::encode(ImageRef::new(2, 2, ColorType::Gray, png::BitDepth::Eight, &gray)?)?;

let image = Decoder::new().max_image_bytes(1 << 20).decode(&file)?;
assert_eq!((image.width(), image.height()), (2, 2));
assert_eq!(image.data(), gray);
assert_eq!(&image.to_rgba8()[4..8], [64, 64, 64, 255]);

let tiny_limit = Decoder::new().max_image_bytes(3);
assert!(tiny_limit.decode(&file).is_err());

Implementations§

Source§

impl Decoder

Source

pub const DEFAULT_MAX_IMAGE_BYTES: usize

The default limit on decoded pixel data: 1 GiB.

Source

pub const fn new() -> Self

A decoder with the default limit.

Source

pub const fn max_image_bytes(self, limit: usize) -> Self

Sets the largest pixel buffer (in PNG layout, see DecodedImage::data) the decoder will produce; larger images fail with DecodeError::ImageTooLarge before any pixel memory is allocated.

Source

pub fn decode(&self, png: &[u8]) -> Result<DecodedImage, DecodeError>

Decodes a complete PNG file.

Trait Implementations§

Source§

impl Clone for Decoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Decoder

Source§

impl Debug for Decoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Decoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Decoder

Source§

impl PartialEq for Decoder

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Decoder

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.