Struct distill_loader::handle::WeakHandle

pub struct WeakHandle { /* fields omitted */ }

Handle to an asset that does not prevent the asset from being unloaded.

Weak handles are primarily used when you want to use something that is already loaded.

For example, a strong handle to an asset may be guaranteed to exist elsewhere in the program, and so you can simply get and use a weak handle to that asset in other parts of your code. This removes reference counting overhead, but also ensures that the system which uses the weak handle is not in control of when to unload the asset.

Implementations

impl WeakHandle

pub fn new(handle: LoadHandle) -> Self

Trait Implementations

impl AssetHandle for WeakHandle

fn load_handle(&self) -> LoadHandle

Returns the LoadHandle of this asset handle.

fn load_status(&self, loader: &Loader) -> LoadStatus

Returns the load status of the asset.

fn asset<'a, T, S: TypedAssetStorage<T>>(&self, storage: &'a S) -> Option<&'a T> where
    Self: Sized, 

Returns an immutable reference to the asset if it is committed.

fn asset_version<T, S: TypedAssetStorage<T>>(&self, storage: &S) -> Option<u32> where
    Self: Sized, 

Returns the version of the asset if it is committed.

fn asset_with_version<'a, T, S: TypedAssetStorage<T>>(
    &self,
    storage: &'a S
) -> Option<(&'a T, u32)> where
    Self: Sized, 

Returns the asset with the given version if it is committed.

fn downgrade(&self) -> WeakHandle

Downgrades this handle into a WeakHandle.

impl Clone for WeakHandle

fn clone(&self) -> WeakHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeakHandle

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

Formats the value using the given formatter.

impl Eq for WeakHandle

impl Hash for WeakHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<WeakHandle> for WeakHandle

fn eq(&self, other: &WeakHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WeakHandle) -> bool

This method tests for !=.

impl StructuralEq for WeakHandle

impl StructuralPartialEq for WeakHandle