TileCache

Struct TileCache 

Source
pub struct TileCache { /* private fields */ }
Expand description

LRU cache for encoded JPEG tiles with size-based capacity.

This cache stores encoded tile data and evicts least-recently-used entries when the total cached size exceeds capacity.

§Thread Safety

The cache is thread-safe and can be shared across async tasks via Arc.

§Example

use wsi_streamer::tile::{TileCache, TileCacheKey};
use bytes::Bytes;
use std::sync::Arc;

#[tokio::main]
async fn main() {
    let cache = TileCache::new();

    let key = TileCacheKey::new("slides/sample.svs", 0, 1, 2, 80);
    let tile_data = Bytes::from(vec![0xFF, 0xD8, 0xFF, 0xE0]); // JPEG header

    // Store tile
    cache.put(key.clone(), tile_data.clone()).await;

    // Retrieve tile
    let cached = cache.get(&key).await;
    assert_eq!(cached, Some(tile_data));
}

Implementations§

Source§

impl TileCache

Source

pub fn new() -> Self

Create a new tile cache with default capacity (100MB).

Source

pub fn with_capacity(max_size: usize) -> Self

Create a new tile cache with the specified capacity in bytes.

§Arguments
  • max_size - Maximum total size of cached tiles in bytes
Source

pub fn with_capacity_and_entries(max_size: usize, max_entries: usize) -> Self

Create a new tile cache with specified capacity and maximum entries.

§Arguments
  • max_size - Maximum total size of cached tiles in bytes
  • max_entries - Maximum number of entries in the cache
Source

pub async fn get(&self, key: &TileCacheKey) -> Option<Bytes>

Get a tile from the cache.

Returns Some(data) if the tile is cached, None otherwise. This operation marks the entry as recently used.

Source

pub async fn contains(&self, key: &TileCacheKey) -> bool

Check if a tile is in the cache without updating LRU order.

Returns true if the tile is cached, false otherwise.

Source

pub async fn put(&self, key: TileCacheKey, data: Bytes)

Store a tile in the cache.

If the cache is over capacity after insertion, least-recently-used entries are evicted until the cache is within capacity.

If the tile already exists, it is updated and marked as recently used.

Source

pub async fn remove(&self, key: &TileCacheKey) -> Option<Bytes>

Remove a tile from the cache.

Returns the cached data if it existed, None otherwise.

Source

pub async fn clear(&self)

Clear all entries from the cache.

Source

pub async fn len(&self) -> usize

Get the current number of cached tiles.

Source

pub async fn is_empty(&self) -> bool

Check if the cache is empty.

Source

pub async fn size(&self) -> usize

Get the current total size of cached tiles in bytes.

Source

pub fn capacity(&self) -> usize

Get the maximum capacity in bytes.

Trait Implementations§

Source§

impl Default for TileCache

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more