Struct RetainAllImageCache 

pub struct RetainAllImageCache(/* private fields */);

An ImageCache that keeps every image it loads until you clear it, remove a source, or drop the cache.

Create one with RetainAllImageCache::new, or let retain_all create one for an element. Loads run on the background executor, and the view that asked is notified when each finishes. Dropping the cache drops its decoded images from the windows.

Implementations

impl RetainAllImageCache

pub fn new(cx: &mut App) -> Entity<Self>

Creates a cache as an app entity. Its images are dropped from the windows when the entity is released.

Keep the returned Entity alive for as long as its images are needed.

pub fn load( &mut self, source: &Resource, window: &mut Window, cx: &mut App, ) -> Option<Result<Arc<RenderImage>, ImageCacheError>>

Returns the image for source, starting its load on the first request.

Returns None while the image loads. After that, it returns the same result on every call, including an error. Requests for one source share a single load. See ImageCache::load.

pub fn clear(&mut self, window: &mut Window, cx: &mut App)

Removes every entry and drops the decoded images from the windows.

A load still in progress is forgotten, so the next request for its source starts again.

pub fn remove(&mut self, source: &Resource, window: &mut Window, cx: &mut App)

Removes one source and drops its decoded image from the windows. The next request for it loads it again.

pub fn len(&self) -> usize

Returns the number of sources in the cache, including ones still loading.

pub fn is_empty(&self) -> bool

Returns true if the cache holds no sources, including ones still loading.

Trait Implementations

impl Debug for RetainAllImageCache

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

Formats the value using the given formatter.

impl ImageCache for RetainAllImageCache

fn load( &mut self, resource: &Resource, window: &mut Window, cx: &mut App, ) -> Option<Result<Arc<RenderImage>, ImageCacheError>>

Returns the image for resource if it is ready, or None while it loads.