Struct JxlDecoder 

pub struct JxlDecoder { /* private fields */ }

Decodes a JPEG XL stream.

Implementations

impl JxlDecoder

pub fn new<S>(source: S, limits: Limits) -> Result<JxlDecoder, PixelsError>

where S: Source,

Read the file and parse its headers; the pixels decode when the first row is read.

Errors

Returns PixelsError::Malformed for headers it rejects, or PixelsError::LimitExceeded if the image exceeds limits.

Trait Implementations

impl Debug for JxlDecoder

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

Formats the value using the given formatter.

impl Decoder for JxlDecoder

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

The container’s xml box.

fn source_info(&self) -> SourceInfo

Bit depth, and lossy (XYB) or lossless.

fn descriptor(&self) -> ImageDescriptor

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

fn orientation(&self) -> Orientation

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

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

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

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

The embedded EXIF block, if the file carries one: the TIFF-structured bytes from the byte-order mark (II or MM), without the Exif\0\0 identifier a JPEG wraps it in.

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

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

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

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

fn capability(&self) -> DecodeCapability

What this decoder can produce without a full decode.

fn pages(&self) -> u32

How many pages the source document holds, at least 1.

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.