Struct fyrox_resource::Resource

pub struct Resource<T>
where
    T: TypedResourceData,
{ /* private fields */ }

A resource of particular data type. It is a typed wrapper around UntypedResource which does type checks at runtime.

Default State

Default state of the resource will be ResourceState::Ok with T::default.

Implementations

impl<T> Resource<T>

where T: TypedResourceData,

pub const UNTYPED: &'static str = "untyped"

impl<T> Resource<T>

where T: TypedResourceData,

pub fn new_pending(kind: ResourceKind) -> Self

Creates new resource in pending state.

pub fn new_ok(kind: ResourceKind, data: T) -> Self

Creates new resource in ok state (fully loaded).

pub fn new_load_error(kind: ResourceKind, error: LoadError) -> Self

Creates new resource in error state.

pub fn into_untyped(self) -> UntypedResource

Converts self to internal value.

pub fn state(&self) -> ResourceHeaderGuard<'_, T>

Locks internal mutex provides access to the state.

pub fn try_acquire_state(&self) -> Option<ResourceHeaderGuard<'_, T>>

Tries to lock internal mutex provides access to the state.

pub fn header(&self) -> MutexGuard<'_, ResourceHeader>

pub fn is_loading(&self) -> bool

Returns true if the resource is still loading.

pub fn is_ok(&self) -> bool

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

pub fn is_failed_to_load(&self) -> bool

Returns true if the resource is failed to load.

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 kind(&self) -> ResourceKind

Returns kind of the resource.

pub fn set_path(&mut self, new_kind: ResourceKind)

Sets a new kind of the resource.

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

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> Clone for Resource<T>

where T: TypedResourceData,

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 for Resource<T>

where T: TypedResourceData + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Resource<T>

where T: TypedResourceData,

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<UntypedResource> for Resource<T>

where T: TypedResourceData,

fn from(untyped: UntypedResource) -> Self

Converts to this type from the input type.

impl<T> Future for Resource<T>

where T: TypedResourceData,

type Output = Result<Resource<T>, LoadError>

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> Hash for Resource<T>

where T: TypedResourceData,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Into<UntypedResource> for Resource<T>

where T: TypedResourceData,

fn into(self) -> UntypedResource

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

impl<T> PartialEq for Resource<T>

where T: TypedResourceData,

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Reflect for Resource<T>

where T: TypedResourceData, Self: 'static, UntypedResource: Reflect,

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect> ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>) )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>) )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>) )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>) )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>) )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>) )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>) )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>) )

impl<T: TypedResourceData> TypeUuidProvider for Resource<T>

fn type_uuid() -> Uuid

Return type UUID.

impl<T> Visit for Resource<T>

where T: TypedResourceData,

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

impl<T> Eq for Resource<T>

where T: TypedResourceData,