Struct image::pnm::PnmDecoder
source · [−]pub struct PnmDecoder<R> { /* private fields */ }
Expand description
PNM decoder
Implementations
sourceimpl<R: Read> PnmDecoder<R>
impl<R: Read> PnmDecoder<R>
sourcepub fn new(read: R) -> ImageResult<PnmDecoder<R>>
pub fn new(read: R) -> ImageResult<PnmDecoder<R>>
Create a new decoder that decodes from the stream read
sourcepub fn into_inner(self) -> (R, PnmHeader)
pub fn into_inner(self) -> (R, PnmHeader)
Extract the reader and header after an image has been read.
sourceimpl<R: Read> PnmDecoder<R>
impl<R: Read> PnmDecoder<R>
sourcepub fn subtype(&self) -> PNMSubtype
pub fn subtype(&self) -> PNMSubtype
Get the pnm subtype, depending on the magic constant contained in the header
Trait Implementations
sourceimpl<'a, R: 'a + Read> ImageDecoder<'a> for PnmDecoder<R>
impl<'a, R: 'a + Read> ImageDecoder<'a> for PnmDecoder<R>
type Reader = PnmReader<R>
type Reader = PnmReader<R>
The type of reader produced by into_reader
.
sourcefn dimensions(&self) -> (u32, u32)
fn dimensions(&self) -> (u32, u32)
Returns a tuple containing the width and height of the image
sourcefn color_type(&self) -> ColorType
fn color_type(&self) -> ColorType
Returns the color type of the image data produced by this decoder
sourcefn original_color_type(&self) -> ExtendedColorType
fn original_color_type(&self) -> ExtendedColorType
Retuns the color type of the image file before decoding
sourcefn into_reader(self) -> ImageResult<Self::Reader>
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. Read more
sourcefn read_image(self, buf: &mut [u8]) -> ImageResult<()>
fn read_image(self, buf: &mut [u8]) -> ImageResult<()>
Returns all the bytes in the image. Read more
sourcefn total_bytes(&self) -> u64
fn total_bytes(&self) -> u64
Returns the total number of bytes in the decoded image. Read more
sourcefn scanline_bytes(&self) -> u64
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()
. Read more
sourcefn read_image_with_progress<F: Fn(Progress)>(
self,
buf: &mut [u8],
progress_callback: F
) -> ImageResult<()>
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. Read more
Auto Trait Implementations
impl<R> RefUnwindSafe for PnmDecoder<R> where
R: RefUnwindSafe,
impl<R> Send for PnmDecoder<R> where
R: Send,
impl<R> Sync for PnmDecoder<R> where
R: Sync,
impl<R> Unpin for PnmDecoder<R> where
R: Unpin,
impl<R> UnwindSafe for PnmDecoder<R> where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more