Struct TiffDecoder 

pub struct TiffDecoder { /* private fields */ }

Decodes a TIFF stream.

Implementations

impl TiffDecoder

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

where S: Source,

Read and parse a TIFF, decoding its first page.

Errors

Returns PixelsError::Malformed for a bad header or directory, PixelsError::Unsupported for a layout this codec does not implement, or PixelsError::LimitExceeded if the image exceeds limits.

pub fn with_page<S>( source: S, limits: Limits, page: u32, ) -> Result<TiffDecoder, PixelsError>

where S: Source,

Read and parse a TIFF, decoding page page (0 is the first).

A multi-page TIFF is a chain of image directories, one per page — a stack of scans or faxes. Every page is counted when the file is opened (Decoder::pages), reading only each directory’s size and link, and only the chosen page is parsed and decoded.

Errors

As TiffDecoder::new, and PixelsError::InvalidArgument if the file has no page page.

pub const fn image(&self) -> &TiffImage

The parsed image description.

pub const fn byte_order(&self) -> ByteOrder

The byte order the file declared.

Trait Implementations

impl Debug for TiffDecoder

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

Formats the value using the given formatter.

impl Decoder for TiffDecoder

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

The page’s descriptive tags (make, model, date, resolution, orientation, …) and its Exif and GPS directories, laid out as an EXIF block.

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

The page’s XMP packet, tag 700.

fn source_info(&self) -> SourceInfo

Density, compression, bit depth and palette.

fn descriptor(&self) -> ImageDescriptor

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

fn pages(&self) -> u32

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

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 capability(&self) -> DecodeCapability

What this decoder can produce without a full decode.

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

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

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

Decode an arbitrary region into out.

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

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

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.