Enum ImageSource 

pub enum ImageSource {
    Resource(Resource),
    Render(Arc<RenderImage>),
    Image(Arc<Image>),
    Custom(Arc<dyn Fn(&mut Window, &mut App) -> Option<Result<Arc<RenderImage>, ImageCacheError>>>),
}

Where an img element gets its pixels.

You rarely build this yourself. Each argument to img converts into one variant: a string, a PathBuf or a SharedUri becomes ImageSource::Resource, an Arc<Image> becomes ImageSource::Image, and an Arc<RenderImage> becomes ImageSource::Render.

How a string is read

A &str, String or SharedString is a URL if the url crate parses it, and an asset path otherwise. Any scheme counts, so "https://example.com/a.png" is a URL, and so are "c:/logo.png" (a Windows drive path) and "data:...". URLs go to the app’s HTTP client, which normally rejects schemes it doesn’t handle. "images/logo.png" has no scheme, so it is looked up in the crate::AssetRegistry.

To skip that check, convert a PathBuf or a SharedUri instead. A PathBuf always reads the file system, and a SharedUri always fetches.

Variants

Resource(Resource)

Load the image from a Resource: a URL, a file path or a name in the crate::AssetRegistry.

The bytes load in the background and are cached by source.

Render(Arc<RenderImage>)

Pixels that are already decoded. Nothing is loaded, and the frames are drawn as they are.

Image(Arc<Image>)

Encoded bytes in an Image, such as a PNG or an SVG. The image is decoded in the background and cached under the Image’s ID, which is a hash of its bytes.

Custom(Arc<dyn Fn(&mut Window, &mut App) -> Option<Result<Arc<RenderImage>, ImageCacheError>>>)

A function that the element calls on every layout and paint to get the image.

Return None while the image is not ready, Some(Ok(..)) with the image, or Some(Err(..)) to show the fallback. gpui doesn’t cache the result, so the function must be fast or cache its own result.

Implementations

impl ImageSource

pub fn remove_asset(&self, cx: &mut App)

Evicts this source from the app’s asset cache, so the next img that uses it loads it again.

Only ImageSource::Resource and ImageSource::Image are in that cache, so the other variants do nothing. Images held by an crate::image_cache element are not affected.

pub fn is_asset_cached(&self, cx: &App) -> bool

Returns true if this source is loading or loaded in the app’s asset cache. Starts no load.

Available with the test-support feature. Use it in tests to check that an image was requested or evicted.

Trait Implementations

impl Clone for ImageSource

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> From<&'a str> for ImageSource

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<&Path> for ImageSource

fn from(value: &Path) -> Self

Converts to this type from the input type.

impl From<Arc<Image>> for ImageSource

fn from(value: Arc<Image>) -> Self

Converts to this type from the input type.

impl From<Arc<Path>> for ImageSource

fn from(value: Arc<Path>) -> Self

Converts to this type from the input type.

impl From<Arc<RenderImage>> for ImageSource

fn from(value: Arc<RenderImage>) -> Self

Converts to this type from the input type.

impl<F> From<F> for ImageSource

where F: Fn(&mut Window, &mut App) -> Option<Result<Arc<RenderImage>, ImageCacheError>> + 'static,

fn from(value: F) -> Self

Converts to this type from the input type.

impl From<PathBuf> for ImageSource

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl From<SharedString> for ImageSource

fn from(s: SharedString) -> Self

Converts to this type from the input type.

impl From<SharedUri> for ImageSource

fn from(value: SharedUri) -> Self

Converts to this type from the input type.

impl From<String> for ImageSource

fn from(s: String) -> Self

Converts to this type from the input type.