Struct AssetLoadingState 

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

Loading state with asset key information for error reporting.

This is returned by ctx.asset() and provides information about whether an asset is loading or ready, along with the key for error reporting on suspend.

Example

#[query]
fn process_file(ctx: &mut QueryContext, path: FilePath) -> Result<Output, QueryError> {
    let content = ctx.asset(path)?.suspend()?;
    // Process content...
    Ok(output)
}

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).

Use this with the ? operator to propagate loading state upward. The returned error includes the asset key for debugging.

Example

fn query(&self, ctx: &mut QueryContext) -> Result<MyOutput, QueryError> {
    let data = ctx.asset(key)?.suspend()?;
    // `data` is guaranteed to be ready here
    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.