Struct fyrox_resource::Resource

pub struct Resource<T, E> where
    T: ResourceData,
    E: ResourceLoadError,  { /* private fields */ }

See module docs.

Implementations

impl<T: ResourceData, E: ResourceLoadError> Resource<T, E>

pub fn new(state: ResourceState<T, E>) -> Self

Creates new resource with a given state.

pub fn into_inner(self) -> Arc<Mutex<ResourceState<T, E>>>

Converts self to internal value.

pub fn state(&self) -> MutexGuard<'_, ResourceState<T, E>>

Locks internal mutex provides access to the state.

pub fn try_acquire_state(&self) -> Option<MutexGuard<'_, ResourceState<T, E>>>

Tries to lock internal mutex provides access to the state.

pub fn use_count(&self) -> usize

Returns exact amount of users of the resource.

pub fn key(&self) -> usize

Returns a pointer as numeric value which can be used as a hash.

pub fn data_ref(&self) -> ResourceDataRef<'_, T, E>

Allows you to obtain reference to the resource data.

Panic

An attempt to use method result will panic if resource is not loaded yet, or there was load error. Usually this is ok because normally you’d chain this call like this resource.await?.data_ref(). Every resource implements Future trait and it returns Result, so if you’ll await future then you’ll get Result, so call to data_ref will be fine.

Trait Implementations

impl<T: ResourceData, E: ResourceLoadError> Clone for Resource<T, E>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug> Debug for Resource<T, E> where
    T: ResourceData,
    E: ResourceLoadError, 

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

Formats the value using the given formatter.

impl<T: ResourceData, E: ResourceLoadError> Default for Resource<T, E>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ResourceData, E: ResourceLoadError> From<Arc<Mutex<RawMutex, ResourceState<T, E>>>> for Resource<T, E>

fn from(state: Arc<Mutex<ResourceState<T, E>>>) -> Self

Converts to this type from the input type.

impl<T: ResourceData, E: ResourceLoadError> Future for Resource<T, E>

type Output = Result<Resource<T, E>, Option<Arc<E>>>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

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

impl<T, E> Hash for Resource<T, E> where
    T: ResourceData,
    E: ResourceLoadError, 

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

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<T: ResourceData, E: ResourceLoadError> Into<Arc<Mutex<RawMutex, ResourceState<T, E>>>> for Resource<T, E>

fn into(self) -> Arc<Mutex<ResourceState<T, E>>>

Converts this type into the (usually inferred) input type.

impl<T, E> PartialEq<Resource<T, E>> for Resource<T, E> where
    T: ResourceData,
    E: ResourceLoadError, 

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

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

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

This method tests for !=.

impl<T, E> Visit for Resource<T, E> where
    T: ResourceData,
    E: ResourceLoadError,
    Option<Arc<Mutex<ResourceState<T, E>>>>: Visit, 

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

impl<T, E> Eq for Resource<T, E> where
    T: ResourceData,
    E: ResourceLoadError,