Struct Assets 

pub struct Assets<T: 'static + Send + Sync> { /* private fields */ }

Storage for raw CPU-side assets of type T.

Assets are inserted by name and looked up by either name or RawAssetHandle. When an asset is inserted or updated its handle is pushed onto the dirty queue, which the sync system drains each tick to upload changed assets to the GPU.

Implementations

impl<T: 'static + Send + Sync> Assets<T>

pub fn new() -> Self

pub fn insert(&mut self, name: &str, asset: T) -> RawAssetHandle

Insert asset under name, returning its handle.

If an asset with the same name already exists, its data is replaced in-place: the same slot-map entry (and therefore the same handle) is reused, so any code that already holds a Handle or RawAssetHandle for this asset continues to work correctly. The handle is re-queued so the sync system re-uploads the new data.

pub fn get(&self, handle: RawAssetHandle) -> Option<&T>

Look up an asset by its raw handle.

pub fn get_mut(&mut self, handle: RawAssetHandle) -> Option<&mut T>

Mutably look up an asset by its raw handle.

pub fn get_by_name(&self, name: &str) -> Option<&T>

Look up an asset by its name.

pub fn get_mut_by_name(&mut self, name: &str) -> Option<&mut T>

Mutably look up an asset by its name.

pub fn get_handle_by_name(&self, name: &str) -> Option<RawAssetHandle>

Look up an asset handle by its name.

pub fn take_dirty(&mut self) -> Vec<RawAssetHandle>

Drain and return all handles currently in the dirty queue.

Called by the asset sync system each tick.

pub fn remove(&mut self, handle: RawAssetHandle) -> Option<T>

Remove an asset by handle, returning the value if it existed.

pub fn remove_by_name(&mut self, name: &str) -> Option<T>

Remove an asset by name, returning the value if it existed.

pub fn take_removed(&mut self) -> Vec<RawAssetHandle>

Drain and return all handles removed since the last call.

Called by the asset sync system each tick to evict stale processed assets.

pub fn dirty_is_empty(&self) -> bool

Returns true if the dirty queue is empty.

pub fn dirty_len(&self) -> usize

Returns the number of handles currently in the dirty queue.

pub fn requeue(&mut self, handles: Vec<RawAssetHandle>)

Push handles back onto the dirty queue so they are retried next tick.

pub fn iter(&self) -> impl Iterator<Item = (RawAssetHandle, &T)>

Iterate over all assets by handle.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (RawAssetHandle, &mut T)>

Mutably iterate over all assets by handle.

pub fn names(&self) -> impl Iterator<Item = (&str, RawAssetHandle)>

Iterate over (name, handle) pairs for every named asset.

pub fn name_for_handle(&self, handle: RawAssetHandle) -> Option<&str>

Trait Implementations

impl<'a, T: 'static + Send + Sync> IntoIterator for &'a Assets<T>

type Item = (RawAssetHandle, &'a T)

The type of the elements being iterated over.

type IntoIter = Iter<'a, RawAssetHandle, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: 'static + Send + Sync> IntoIterator for &'a mut Assets<T>

type Item = (RawAssetHandle, &'a mut T)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, RawAssetHandle, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.