Trait egui::load::BytesLoader

source · 
pub trait BytesLoader {
    // Required methods
    fn id(&self) -> &str;
    fn load(&self, ctx: &Context, uri: &str) -> BytesLoadResult;
    fn forget(&self, uri: &str);
    fn forget_all(&self);
    fn byte_size(&self) -> usize;

    // Provided method
    fn end_frame(&self, frame_index: usize) { ... }
}
Expand description

Represents a loader capable of loading raw unstructured bytes from somewhere, e.g. from disk or network.

It should also provide any subsequent loaders a hint for what the bytes may represent using BytesPoll::Ready::mime, if it can be inferred.

Implementations are expected to cache at least each URI.

Required Methods§

source

fn id(&self) -> &str

Unique ID of this loader.

To reduce the chance of collisions, use generate_loader_id for this.

source

fn load(&self, ctx: &Context, uri: &str) -> BytesLoadResult

Try loading the bytes from the given uri.

Implementations should call ctx.request_repaint to wake up the ui once the data is ready.

The implementation should cache any result, so that calling this is immediate-mode safe.

§Errors

This may fail with:

source

fn forget(&self, uri: &str)

Forget the given uri.

If uri is cached, it should be evicted from cache, so that it may be fully reloaded.

source

fn forget_all(&self)

Forget all URIs ever given to this loader.

If the loader caches any URIs, the entire cache should be cleared, so that all of them may be fully reloaded.

source

fn byte_size(&self) -> usize

If the loader caches any data, this should return the size of that cache.

Provided Methods§

source

fn end_frame(&self, frame_index: usize)

Implementations may use this to perform work at the end of a frame, such as evicting unused entries from a cache.

Implementors§