Skip to main content

ThumbnailCache

Struct ThumbnailCache 

Source
pub struct ThumbnailCache {
    api_client: Arc<ImmichApiClient>,
    memory: Mutex<SizedLruCache>,
    cache_dir: PathBuf,
    small_semaphore: Arc<Semaphore>,
    large_semaphore: Arc<Semaphore>,
    inflight: Arc<Mutex<HashMap<String, Receiver<Option<Result<Texture, String>>>>>>,
}
Expand description

A combined memory (LRU) and disk-based caching manager for remote and local assets.

Fields§

§api_client: Arc<ImmichApiClient>§memory: Mutex<SizedLruCache>§cache_dir: PathBuf§small_semaphore: Arc<Semaphore>§large_semaphore: Arc<Semaphore>§inflight: Arc<Mutex<HashMap<String, Receiver<Option<Result<Texture, String>>>>>>

Implementations§

Source§

impl ThumbnailCache

Source

const AUTO_MIN_BYTES: usize

Floor for the auto-sized RAM budget, so very low-memory systems still hold a working set of decoded thumbnails.

Source

const AUTO_MAX_BYTES: usize

Source

const AUTO_FRACTION_PERCENT: usize = 20

Source

pub fn new(api_client: Arc<ImmichApiClient>) -> Self

Construct a new thumbnail cache manager. Disk pruning is handled centrally by cache_manager at startup, not here.

Source

pub fn get_cached(&self, asset_id: &str, size: ThumbnailSize) -> Option<Texture>

Retrieve a thumbnail texture from memory if present, updating LRU recency.

Source

pub fn peek_cached( &self, asset_id: &str, size: ThumbnailSize, ) -> Option<Texture>

Same as get_cached but does not touch LRU order. Use for read-only per-frame paint lookups.

Source

pub fn cache_stats(&self) -> (usize, usize, usize, usize)

(entries, current_bytes, max_bytes, evictions_since_last_call).

Source

fn semaphore_for(&self, size: ThumbnailSize) -> Arc<Semaphore>

Source

pub async fn load_thumbnail( &self, asset_id: &str, size: ThumbnailSize, ) -> Result<Texture, String>

Asynchronously fetch a remote thumbnail with default non-cancellable execution.

Source

pub async fn load_thumbnail_cancellable<F>( &self, asset_id: &str, size: ThumbnailSize, is_cancelled: F, ) -> Result<Texture, String>
where F: Fn() -> bool,

Asynchronously fetch a remote thumbnail with cancellable hook support.

Source

async fn fetch_remote_thumbnail( &self, asset_id: &str, size: ThumbnailSize, key: &str, is_cancelled: &dyn Fn() -> bool, ) -> Result<Texture, String>

Internal helper that performs the actual network request and disk backup logic.

Source

pub async fn load_local_thumbnail_cancellable<F>( &self, asset_id: &str, path: &Path, is_cancelled: F, ) -> Result<Texture, String>
where F: Fn() -> bool,

Asynchronously generate a local file thumbnail with cancellable hook support.

Source

async fn fetch_local_thumbnail( &self, asset_id: &str, path: &Path, key: &str, is_cancelled: &dyn Fn() -> bool, ) -> Result<Texture, String>

Internal helper that scales, saves, and loads a local folder asset thumbnail.

Source

pub fn clear(&self) -> Result<(), String>

Purge all memory caches and completely delete the disk cache directory.

Source

pub fn clear_memory(&self)

Drop every cached texture from RAM without touching the disk cache. Invoked when the library window closes so the texture memory is released until the user reopens it.

Source

fn cache_file(&self, asset_id: &str, size: ThumbnailSize) -> PathBuf

Return the physical disk cache path for a remote asset thumbnail.

Source

fn cache_file_local(&self, asset_id: &str) -> PathBuf

Return the physical disk cache path for a local folder asset thumbnail.

Source

fn enter_inflight( &self, key: &str, ) -> Result<InflightGuard, Receiver<Option<Result<Texture, String>>>>

Register or join an ongoing in-flight loading request for a key.

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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