Struct image::codecs::pnm::PnmDecoder

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

[−] Expand description

PNM decoder

Implementations

impl<R: Read> PnmDecoder<R>[−]

pub fn new(read: R) -> ImageResult<PnmDecoder<R>>[−]

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: Read> PnmDecoder<R>[−]

pub fn subtype(&self) -> PNMSubtype[−]

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

Trait Implementations

impl<'a, R: 'a + Read> ImageDecoder<'a> for PnmDecoder<R>[+]

[+] Show hidden undocumented items

type Reader = PnmReader<R>

The type of reader produced by into_reader.

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[−]

Retuns the color type of the image file before decoding

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

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.

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

Returns all the bytes in the image.

fn total_bytes(&self) -> u64[−]

Returns the total number of bytes in the decoded image.

fn scanline_bytes(&self) -> u64[−]

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

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

Same as read_image but periodically calls the provided callback to give updates on loading progress.