Struct PnmDecoder

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

Available on crate feature dep_image only.

PNM decoder

Implementations

impl<R> PnmDecoder<R>

where R: Read,

pub fn new(buffered_read: R) -> Result<PnmDecoder<R>, ImageError>

Create a new decoder that decodes from the stream read

pub fn into_inner(self) -> (R, PnmHeader)

Extract the reader and header after an image has been read.

impl<R> PnmDecoder<R>

where R: Read,

pub fn subtype(&self) -> PnmSubtype

Get the pnm subtype, depending on the magic constant contained in the header

Trait Implementations

impl<R> ImageDecoder for PnmDecoder<R>

where R: Read,

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 original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

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

Returns all the bytes in the image.

fn read_image_boxed( self: Box<PnmDecoder<R>>, buf: &mut [u8], ) -> Result<(), ImageError>

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

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 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.

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

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