Struct AssetLoadingState 

pub struct AssetLoadingState<K: AssetKey> { /* private fields */ }

Loading state with asset key information for error reporting.

This is returned by Db::asset_state() and provides information about whether an asset is loading or ready.

For most use cases, prefer Db::asset() which automatically suspends on loading. Use asset_state() when you need to explicitly check the loading state without triggering suspension.

Example

#[query]
fn process_file(db: &impl Db, path: FilePath) -> Result<Output, QueryError> {
    // Most common: just use db.asset() which suspends automatically
    let content = db.asset(path)?;
    Ok(process(&content))
}

#[query]
fn check_loading(db: &impl Db, path: FilePath) -> Result<bool, QueryError> {
    // Use asset_state() when you need to check loading status explicitly
    let state = db.asset_state(path)?;
    Ok(state.is_loading())
}

Implementations

impl<K: AssetKey> AssetLoadingState<K>

pub fn loading(key: K) -> Self

Create a loading state (asset not yet available).

pub fn ready(key: K, value: Arc<K::Asset>) -> Self

Create a ready state with the asset value.

pub fn is_loading(&self) -> bool

Check if the resource is still loading.

pub fn is_ready(&self) -> bool

Check if the resource is ready.

pub fn get(&self) -> Option<&Arc<K::Asset>>

Get the value if ready, None if loading.

pub fn into_inner(self) -> Option<Arc<K::Asset>>

Get the value if ready, None if loading (consuming version).

pub fn suspend(self) -> Result<Arc<K::Asset>, QueryError>

Convert to Result - Loading becomes Err(QueryError::Suspend).

This method is used internally by Db::asset(). You can also use it when working with Db::asset_state().

Example

fn query(&self, db: &impl Db) -> Result<MyOutput, QueryError> {
    // Preferred: use db.asset() directly
    let data = db.asset(key)?;

    // Alternative: use asset_state() + suspend()
    let state = db.asset_state(key)?;
    let data = state.suspend()?;

    Ok(process(&data))
}

pub fn key(&self) -> &K

Get a reference to the key.

Trait Implementations

impl<K: AssetKey> Debug for AssetLoadingState<K>

where K::Asset: Debug,

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

Formats the value using the given formatter.