Struct HandleLoadState 

pub struct HandleLoadState<A: Asset> { /* private fields */ }

Combined handle and load state for convenient asset status checking.

This type wraps an asset handle together with its current loading state, allowing users to check both validity and load progress in one place.

Example

use goud_engine::assets::{Asset, AssetHandle, AssetState, HandleLoadState};

struct Texture;
impl Asset for Texture {}

// Simulate an asset that's loading
let handle: AssetHandle<Texture> = AssetHandle::new(0, 1);
let state = HandleLoadState::new(handle, AssetState::Loading { progress: 0.5 });

assert!(state.is_loading());
assert_eq!(state.progress(), Some(0.5));

// When loaded
let state = HandleLoadState::new(handle, AssetState::Loaded);
assert!(state.is_ready());

Implementations

impl<A: Asset> HandleLoadState<A>

pub fn new(handle: AssetHandle<A>, state: AssetState) -> Self

Creates a new handle load state.

pub fn invalid() -> Self

Creates a handle load state for an invalid handle.

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

Returns a reference to the handle.

pub fn state(&self) -> &AssetState

Returns a reference to the asset state.

pub fn is_valid(&self) -> bool

Returns true if the handle is valid (not INVALID sentinel).

pub fn is_ready(&self) -> bool

Returns true if the asset is fully loaded and ready for use.

pub fn is_loading(&self) -> bool

Returns true if the asset is currently loading.

pub fn is_failed(&self) -> bool

Returns true if the asset failed to load.

pub fn progress(&self) -> Option<f32>

Returns the loading progress if currently loading.

pub fn error(&self) -> Option<&str>

Returns the error message if loading failed.

pub fn into_handle(self) -> AssetHandle<A>

Consumes self and returns the inner handle.

pub fn set_state(&mut self, state: AssetState)

Updates the state.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Asset> Debug for HandleLoadState<A>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<A: PartialEq + Asset> PartialEq for HandleLoadState<A>

fn eq(&self, other: &HandleLoadState<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A: Asset> StructuralPartialEq for HandleLoadState<A>