Struct Slide 

pub struct Slide { /* private fields */ }

Top-level handle. Owns the SlideReader + shared cache.

Implementations

impl Slide

pub fn from_source_with_cache_bytes( source: Box<dyn SlideReader>, cache_bytes: u64, ) -> Self

Construct from an already-opened source with an internal cache budget.

pub fn open(path: impl AsRef<Path>) -> Result<Self, WsiError>

Zero-config entry point: builtin registry + source-aware default cache.

pub fn open_with_options( path: impl AsRef<Path>, options: SlideOpenOptions, ) -> Result<Self, WsiError>

pub fn open_with_cache_bytes( path: impl AsRef<Path>, registry: &FormatRegistry, cache_bytes: u64, ) -> Result<Self, WsiError>

Open with the given registry and an internal cache budget.

pub fn dataset(&self) -> &Dataset

pub fn level_source_kind( &self, scene: usize, series: usize, level: u32, ) -> Result<LevelSourceKind, WsiError>

pub fn cached_tile_present(&self, req: &TileRequest) -> bool

pub fn source(&self) -> &dyn SlideReader

pub fn read_tile( &self, req: &TileRequest, output: TileOutputPreference, ) -> Result<TilePixels, WsiError>

pub fn read_tiles( &self, reqs: &[TileRequest], output: TileOutputPreference, ) -> Result<Vec<TilePixels>, WsiError>

pub fn read_raw_compressed_tile( &self, req: &TileRequest, ) -> Result<RawCompressedTile, WsiError>

pub fn read_region(&self, req: &RegionRequest) -> Result<CpuTile, WsiError>

Read a pixel region, compositing from cached or freshly-decoded tiles.

Validates all indices (scene, series, level, plane axes) before reading. Output buffer metadata (color_space, channels, sample_type, layout) is inherited from the first decoded tile – no hardcoded assumptions.

Only CpuTileLayout::Interleaved is supported for compositing. Planar tiles return WsiError::DisplayConversion.

pub fn read_display_tile( &self, req: &TileViewRequest, ) -> Result<CpuTile, WsiError>

pub fn read_display_tile_with_output( &self, req: &TileViewRequest, output: TileOutputPreference, ) -> Result<CpuTile, WsiError>

pub fn read_region_rgba( &self, req: &RegionRequest, ) -> Result<RgbaImage, WsiError>

Convenience: read a region and convert to RgbaImage. Only works for Uint8 data (brightfield). For Uint16/Float32, use read_region() + to_rgba_windowed() with an explicit DisplayWindow.

pub fn read_region_rgba_windowed( &self, req: &RegionRequest, window: &DisplayWindow, ) -> Result<RgbaImage, WsiError>

Read a region and convert to RgbaImage with explicit windowing. For Uint16/Float32 data (fluorescence, computed images).

pub fn read_associated(&self, name: &str) -> Result<CpuTile, WsiError>

Read an associated image (label, macro, thumbnail). Direct delegation to the underlying SlideReader. No caching.

Trait Implementations

impl Debug for Slide

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

Formats the value using the given formatter.