Skip to main content

WeakAssetHandle

Struct WeakAssetHandle 

Source
pub struct WeakAssetHandle<A: Asset> { /* private fields */ }
Expand description

A weak reference to an asset that doesn’t prevent unloading.

Unlike AssetHandle, a WeakAssetHandle does not contribute to the reference count of an asset. This is useful for caches and lookup tables where you want to reference assets without keeping them loaded.

§Example

use goud_engine::assets::{Asset, AssetHandle, WeakAssetHandle};

struct Texture;
impl Asset for Texture {}

let strong: AssetHandle<Texture> = AssetHandle::new(1, 1);
let weak: WeakAssetHandle<Texture> = WeakAssetHandle::from_handle(&strong);

assert!(weak.is_valid());
assert_eq!(weak.index(), 1);
assert_eq!(weak.generation(), 1);

// Upgrade to strong handle for access (liveness must be checked separately)
let upgraded = weak.upgrade();
assert_eq!(upgraded.index(), 1);

Implementations§

Source§

impl<A: Asset> WeakAssetHandle<A>

Source

pub const INVALID: Self

The invalid weak handle constant.

Source

pub fn from_handle(handle: &AssetHandle<A>) -> Self

Creates a weak handle from a strong handle.

Source

pub const fn new(index: u32, generation: u32) -> Self

Creates a new weak handle with the given index and generation.

Source

pub const fn index(&self) -> u32

Returns the index component.

Source

pub const fn generation(&self) -> u32

Returns the generation component.

Source

pub const fn is_valid(&self) -> bool

Returns true if not the INVALID sentinel.

Source

pub fn upgrade(&self) -> AssetHandle<A>

Upgrades to a strong handle.

Note: This does NOT check if the asset is still alive. Use AssetServer::is_alive() to check liveness before using the handle.

Trait Implementations§

Source§

impl<A: Asset> Clone for WeakAssetHandle<A>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Asset> Debug for WeakAssetHandle<A>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A: Asset> Default for WeakAssetHandle<A>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<A: Asset> From<&AssetHandle<A>> for WeakAssetHandle<A>

Source§

fn from(handle: &AssetHandle<A>) -> Self

Converts to this type from the input type.
Source§

impl<A: Asset> Hash for WeakAssetHandle<A>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<A: Asset> PartialEq for WeakAssetHandle<A>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<A: Asset> Copy for WeakAssetHandle<A>

Source§

impl<A: Asset> Eq for WeakAssetHandle<A>

Auto Trait Implementations§

§

impl<A> Freeze for WeakAssetHandle<A>

§

impl<A> RefUnwindSafe for WeakAssetHandle<A>
where A: RefUnwindSafe,

§

impl<A> Send for WeakAssetHandle<A>

§

impl<A> Sync for WeakAssetHandle<A>

§

impl<A> Unpin for WeakAssetHandle<A>
where A: Unpin,

§

impl<A> UnsafeUnpin for WeakAssetHandle<A>

§

impl<A> UnwindSafe for WeakAssetHandle<A>
where A: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

impl<T> QueryState for T
where T: Send + Sync + Clone + 'static,

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,