Struct GenericTiffReader 

pub struct GenericTiffReader { /* private fields */ }

Reader for generic pyramidal TIFF files.

This reader handles standard tiled TIFF files with JPEG compression. It validates the file structure on open and rejects unsupported configurations.

Implementations

impl GenericTiffReader

pub async fn open<R: RangeReader>(reader: &R) -> Result<Self, TiffError>

Open a generic pyramidal TIFF file.

This reads the TIFF structure, validates it meets requirements, and loads tile offset arrays.

Errors

Returns an error if:

• The file is not a valid TIFF
• The file uses strip organization (not tiles)
• The file uses unsupported compression (not JPEG)
• No pyramid levels are found

pub async fn open_with_validation<R: RangeReader>( reader: &R, ) -> Result<(Self, ValidationResult), TiffError>

Open a generic pyramidal TIFF with detailed validation result.

This is like open() but returns the validation result separately, allowing access to warnings even on success.

pub fn header(&self) -> &TiffHeader

Get the TIFF header.

pub fn warnings(&self) -> &[String]

Get validation warnings from file open.

Warnings indicate non-fatal issues like unusual tile dimensions.

pub fn level_count(&self) -> usize

Get the number of pyramid levels.

pub fn get_level(&self, level: usize) -> Option<&GenericTiffLevelData>

Get data for a specific pyramid level.

pub fn dimensions(&self) -> Option<(u32, u32)>

Get dimensions of the full-resolution (level 0) image.

pub fn level_dimensions(&self, level: usize) -> Option<(u32, u32)>

Get dimensions of a specific level.

pub fn level_downsample(&self, level: usize) -> Option<f64>

Get the downsample factor for a level.

pub fn tile_size(&self, level: usize) -> Option<(u32, u32)>

Get tile size for a level.

pub fn tile_count(&self, level: usize) -> Option<(u32, u32)>

Get the number of tiles in X and Y directions for a level.

pub async fn read_raw_tile<R: RangeReader>( &self, reader: &R, level: usize, tile_x: u32, tile_y: u32, ) -> Result<Bytes, TiffError>

Read raw tile data from the file.

This reads the raw bytes from the file without any processing.

pub async fn read_tile<R: RangeReader>( &self, reader: &R, level: usize, tile_x: u32, tile_y: u32, ) -> Result<Bytes, TiffError>

Read a tile and prepare it for JPEG decoding.

This reads the tile data and merges it with JPEGTables if the tile contains an abbreviated JPEG stream (rare for generic TIFF but handled).

Arguments

• reader - Range reader for the file
• level - Pyramid level index
• tile_x - Tile X coordinate
• tile_y - Tile Y coordinate

Returns

Complete JPEG data ready for decoding.

pub fn best_level_for_downsample(&self, downsample: f64) -> Option<usize>

Find the best level for a given downsample factor.

Returns the level with the smallest downsample that is >= the requested factor.

Trait Implementations

impl Debug for GenericTiffReader

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

Formats the value using the given formatter.

impl SlideReader for GenericTiffReader

fn level_count(&self) -> usize

Get the number of pyramid levels.

fn dimensions(&self) -> Option<(u32, u32)>

Get dimensions of the full-resolution (level 0) image.

fn level_dimensions(&self, level: usize) -> Option<(u32, u32)>

Get dimensions of a specific level.

fn level_downsample(&self, level: usize) -> Option<f64>

Get the downsample factor for a level.

fn tile_size(&self, level: usize) -> Option<(u32, u32)>

Get tile size for a level.

fn tile_count(&self, level: usize) -> Option<(u32, u32)>

Get the number of tiles in X and Y directions for a level.

fn best_level_for_downsample(&self, downsample: f64) -> Option<usize>

Find the best level for a given downsample factor.

fn read_tile<'life0, 'life1, 'async_trait, R>( &'life0 self, reader: &'life1 R, level: usize, tile_x: u32, tile_y: u32, ) -> Pin<Box<dyn Future<Output = Result<Bytes, TiffError>> + Send + 'async_trait>>

where R: 'async_trait + RangeReader, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read a tile and prepare it for JPEG decoding.

fn level_info(&self, level: usize) -> Option<LevelInfo>

Get complete information about a level.