Struct image::codecs::pnm::PnmDecoder

pub struct PnmDecoder<R> {
    reader: R,
    header: PnmHeader,
    tuple: TupleType,
}

PNM decoder

Fields

reader: R

header: PnmHeader

tuple: TupleType

Implementations

impl<R: BufRead> PnmDecoder<R>

pub fn new(buffered_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.

fn read_bitmap_header( reader: R, encoding: SampleEncoding, ) -> ImageResult<PnmDecoder<R>>

fn read_graymap_header( reader: R, encoding: SampleEncoding, ) -> ImageResult<PnmDecoder<R>>

fn read_pixmap_header( reader: R, encoding: SampleEncoding, ) -> ImageResult<PnmDecoder<R>>

fn read_arbitrary_header(reader: R) -> ImageResult<PnmDecoder<R>>

impl<R: Read> PnmDecoder<R>

fn read_samples<S: Sample>( &mut self, components: u32, buf: &mut [u8], ) -> ImageResult<()>

fn read_ascii<Basic: Sample>( &mut self, output_buf: &mut [u8], ) -> ImageResult<()>

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>

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

Returns the color type of the image file before decoding

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.

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

Returns all the bytes in the image.

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

Returns the ICC color profile embedded in the image

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

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

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.

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.