Skip to main content

AssetEntry

Struct AssetEntry 

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

An individual asset entry in storage with metadata.

AssetEntry wraps an asset value together with its loading state, optional path association, and other metadata.

§Example

use goud_engine::assets::{Asset, AssetEntry, AssetState, AssetPath};

struct Texture { width: u32 }
impl Asset for Texture {}

// Create a loaded entry
let entry = AssetEntry::loaded(Texture { width: 256 });
assert!(entry.is_loaded());
assert_eq!(entry.asset().unwrap().width, 256);

// Create entry with path
let entry = AssetEntry::with_path(
    Texture { width: 512 },
    AssetPath::new("textures/player.png"),
);
assert_eq!(entry.path().map(|p| p.as_str()), Some("textures/player.png"));

Implementations§

Source§

impl<A: Asset> AssetEntry<A>

Source

pub fn empty() -> Self

Creates a new entry in the NotLoaded state.

Use this when you want to reserve a handle before the asset is loaded.

Source

pub fn loading(progress: f32) -> Self

Creates a new entry with a loading state.

§Arguments
  • progress - Initial loading progress (0.0 to 1.0)
Source

pub fn loaded(asset: A) -> Self

Creates a new entry with a loaded asset.

Source

pub fn with_path(asset: A, path: AssetPath<'static>) -> Self

Creates a new entry with a loaded asset and path.

Source

pub fn failed(error: impl Into<String>) -> Self

Creates a new failed entry with an error message.

Source

pub fn asset(&self) -> Option<&A>

Returns a reference to the asset if loaded.

Source

pub fn asset_mut(&mut self) -> Option<&mut A>

Returns a mutable reference to the asset if loaded.

Source

pub fn take_asset(&mut self) -> Option<A>

Takes the asset out of this entry, leaving None.

Source

pub fn state(&self) -> &AssetState

Returns a reference to the current state.

Source

pub fn path(&self) -> Option<&AssetPath<'static>>

Returns the path this asset was loaded from, if any.

Source

pub fn set_path(&mut self, path: AssetPath<'static>)

Sets the path for this entry.

Source

pub fn clear_path(&mut self)

Clears the path for this entry.

Source

pub fn is_loaded(&self) -> bool

Returns true if the asset is fully loaded.

Source

pub fn is_loading(&self) -> bool

Returns true if the asset is currently loading.

Source

pub fn is_failed(&self) -> bool

Returns true if loading failed.

Source

pub fn set_loaded(&mut self, asset: A)

Sets the asset and marks as loaded.

Source

pub fn set_progress(&mut self, progress: f32)

Updates the loading progress.

Source

pub fn set_failed(&mut self, error: impl Into<String>)

Marks the entry as failed.

Source

pub fn set_unloaded(&mut self)

Marks the entry as unloaded and removes the asset.

Trait Implementations§

Source§

impl<A: Clone + Asset> Clone for AssetEntry<A>

Source§

fn clone(&self) -> AssetEntry<A>

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: Debug + Asset> Debug for AssetEntry<A>

Source§

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

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

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

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<A> Freeze for AssetEntry<A>
where A: Freeze,

§

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

§

impl<A> Send for AssetEntry<A>

§

impl<A> Sync for AssetEntry<A>

§

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

§

impl<A> UnsafeUnpin for AssetEntry<A>
where A: UnsafeUnpin,

§

impl<A> UnwindSafe for AssetEntry<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<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,