Struct goods::Handle

pub struct Handle<A: Asset> { /* fields omitted */ }

Handle for an asset of type A that eventually resolves to the asset instance or an error.

Handle implements Future which helps with compound asset loading. Unlike many Futures Handle semantically is just a pointer to the place where asset isntance will be. So polling Handle isn't necessary for asset to be loaded. When asset is finally loaded any task that polled Handle will be notified.

Implementations

impl<A> Handle<A> where
    A: Asset, 

pub fn query(&self) -> Poll<&Result<A, Error<A>>>

Queries for the asset state. Returns Poll::Ready(Ok(asset)) if asset was successfully loaded. Returns Poll::Ready(Err(error)) if error occured. Otherwise returns Poll::Pending if asset wasn't yet loaded.

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

Returns asset instance if it's loaded.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Eq for Handle<A> where
    A: Asset, 

impl<A> Future for Handle<A> where
    A: Asset, 

type Output = Result<A, Error<A>>

The type of value produced on completion.

fn poll(
    self: Pin<&mut Self>,
    context: &mut Context
) -> Poll<Result<A, Error<A>>>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<A> Hash for Handle<A> where
    A: Asset, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<A> PartialEq<Handle<A>> for Handle<A> where
    A: Asset, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.