Skip to main content

ThumbnailCache

Struct ThumbnailCache 

Source
pub struct ThumbnailCache {
    pub config: ThumbnailCacheConfig,
    /* private fields */
}
Expand description

An in-memory thumbnail request queue + LRU cache.

This type is renderer-agnostic: the application is expected to:

  1. call advance_frame once per UI frame,
  2. drive visibility by calling request_visible for entries that are currently visible,
  3. drain requests via take_requests, decode/upload thumbnails in user code, then call fulfill,
  4. destroy evicted GPU textures from take_pending_destroys.

Fields§

§config: ThumbnailCacheConfig

Cache configuration.

Implementations§

Source§

impl ThumbnailCache

Source

pub fn new(config: ThumbnailCacheConfig) -> Self

Create a new cache with the given config.

Source

pub fn advance_frame(&mut self)

Advance per-frame bookkeeping.

Call this once per UI frame before issuing visibility requests.

Source

pub fn frame_index(&self) -> u64

Returns the internal frame counter.

Source

pub fn request_visible(&mut self, path: &Path, max_size: [u32; 2])

Request a thumbnail for a visible file.

If the thumbnail is not already cached, a request may be queued depending on the per-frame request budget.

Source

pub fn texture_id(&self, path: &Path) -> Option<TextureId>

Returns the cached texture id for a path, if available.

Source

pub fn take_requests(&mut self) -> Vec<ThumbnailRequest>

Drain queued thumbnail requests.

Drained requests are marked as “in flight” until fulfill is called.

Source

pub fn fulfill( &mut self, path: &Path, result: Result<TextureId, String>, _max_size: [u32; 2], )

Complete a request with either a ready texture id or an error string.

Returns any evicted texture ids that should be destroyed by the renderer.

Source

pub fn fulfill_request( &mut self, req: &ThumbnailRequest, result: Result<TextureId, String>, )

Complete a previously issued request.

Source

pub fn maintain(&mut self, backend: &mut ThumbnailBackend<'_>)

Process queued requests and perform pending destroys.

This is a convenience helper for applications that want dear-file-browser to drive the request lifecycle:

If you prefer to manage decoding/upload externally, you can instead use take_requests, fulfill_request, and take_pending_destroys.

Source

pub fn take_pending_destroys(&mut self) -> Vec<TextureId>

Drain GPU textures that should be destroyed after eviction or replacement.

Source

pub fn stats(&self) -> ThumbnailStats

Returns a snapshot of the cache state for UI display.

Trait Implementations§

Source§

impl Clone for ThumbnailCache

Source§

fn clone(&self) -> ThumbnailCache

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ThumbnailCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ThumbnailCache

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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