Struct TiffImage 

#[non_exhaustive]
pub struct TiffImage {

    pub descriptor: ImageDescriptor,
    pub bits_per_sample: u32,
    pub samples_per_pixel: u32,
    pub photometric: Photometric,
    pub compression: Compression,
    pub layout: Layout,
    pub offsets: Vec<u32>,
    pub byte_counts: Vec<u32>,
    pub predictor: bool,
    pub color_map: Vec<u32>,
    pub order: ByteOrder,
    pub orientation: Orientation,
    pub icc: Option<Vec<u8>>,
}

Everything about a TIFF image that decoding needs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

descriptor: ImageDescriptor

The engine-facing descriptor.

bits_per_sample: u32

Bits in each stored sample.

samples_per_pixel: u32

Channels per stored pixel.

photometric: Photometric

How samples are interpreted.

compression: Compression

How pixel data is compressed.

layout: Layout

Strips or tiles.

offsets: Vec<u32>

Byte offset of each chunk.

byte_counts: Vec<u32>

Compressed byte count of each chunk.

predictor: bool

Whether a horizontal differencing predictor was applied.

color_map: Vec<u32>

The colour map, for palette images: 3 * 2^bits 16-bit values.

order: ByteOrder

The byte order the file declared.

orientation: Orientation

The Orientation tag; Orientation::Normal when absent or out of range, which is metadata declined rather than an image refused.

icc: Option<Vec<u8>>

The embedded ICC profile, if the directory carries one.

Implementations

impl TiffImage

pub fn from_directory( directory: &Directory, order: ByteOrder, limits: &Limits, ) -> Result<Self>

Interpret a directory as an image.

Errors

Returns PixelsError::Malformed for a directory missing tags the pixels cannot be located without, PixelsError::Unsupported for a layout this codec does not implement, or PixelsError::LimitExceeded if the dimensions exceed limits.

pub const fn chunks_across(&self) -> u32

The number of chunks (strips or tiles) across the image.

pub const fn chunks_down(&self) -> u32

The number of chunks down the image.

pub fn chunk_region(&self, column: u32, row: u32) -> Region

The region of the image chunk (column, row) covers.

Tiles are always whole even at the image edge — the specification pads them — so the region is clipped for the caller’s benefit rather than describing what is stored.

pub const fn chunk_stored_size(&self) -> (u32, u32)

The stored dimensions of chunk (column, row), including any padding.

pub const fn chunk_row_bytes(&self) -> usize

Bytes one stored row of a chunk occupies.

pub fn read_chunk(&self, data: &[u8], index: usize) -> Result<Vec<u8>>

Decompress chunk index from data, returning stored samples.

Errors

Returns PixelsError::Malformed if the chunk lies outside the file or decompresses to something other than its declared size.

Trait Implementations

impl Clone for TiffImage

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TiffImage

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

Formats the value using the given formatter.