Struct RawDecoder 

pub struct RawDecoder<S: Source> { /* private fields */ }

Decodes a raw pixel stream, one row per call.

Implementations

impl<S: Source> RawDecoder<S>

pub fn new(layout: RawFormat, source: S) -> Result<Self>

Wrap source as a decoder for a stream laid out as layout.

No pixel bytes are read here: construction is the (empty) header parse, so laziness holds and the descriptor is available immediately.

Errors

Returns PixelsError::InvalidArgument if the layout’s byte length overflows usize on this platform.

pub const fn layout(&self) -> RawFormat

The layout this decoder was constructed with.

pub const fn rows_read(&self) -> u32

How many rows have been decoded so far.

Trait Implementations

impl<S: Debug + Source> Debug for RawDecoder<S>

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

Formats the value using the given formatter.

impl<S: Source + Debug> Decoder for RawDecoder<S>

fn descriptor(&self) -> ImageDescriptor

The shape of the image, known after the header is parsed.

fn capability(&self) -> DecodeCapability

What this decoder can produce without a full decode.

fn read_row(&mut self, out: &mut [u8]) -> Result<()>

Decode the next row, top to bottom, into out.

fn orientation(&self) -> Orientation

How the stored image must be turned to display upright, as its metadata declares.

fn animation(&self) -> Option<Animation>

The source’s animation, if it has more than one frame.

fn icc_profile(&self) -> Option<&[u8]>

The embedded ICC colour profile, if the file carries one.

fn read_region( &mut self, region: Region, out: &mut TileMut<'_>, ) -> Result<(), PixelsError>

Decode an arbitrary region into out.

fn reduced_descriptor(&self, target: (u32, u32)) -> Option<ImageDescriptor>

What this decoder would produce if asked for target or larger, when the format lets it reach that size more cheaply than a full decode.

fn reduce_to(&mut self, descriptor: ImageDescriptor) -> Result<(), PixelsError>

Commit to producing descriptor, which Decoder::reduced_descriptor must have returned.