Struct fyrox::asset::untyped::UntypedResource

pub struct UntypedResource(pub Arc<Mutex<RawMutex, ResourceHeader>>);

Untyped resource is a universal way of storing arbitrary resource types. Internally it wraps ResourceState in a Arc<Mutex<> so the untyped resource becomes shareable. In most of the cases you don’t need to deal with untyped resources, use typed Resource wrapper instead. Untyped resource could be useful in cases when you need to collect a set resources of different types in a single collection and do something with them.

Default state

Default state of every untyped resource is ResourceState::LoadError with a warning message, that the resource is in default state. This is a trade-off to prevent wrapping internals into Option, that in some cases could lead to convoluted code with lots of unwraps and state assumptions.

Tuple Fields

0: Arc<Mutex<RawMutex, ResourceHeader>>

Implementations

impl UntypedResource

pub const F_0: &'static str = "0"

impl UntypedResource

pub fn new_pending(kind: ResourceKind, type_uuid: Uuid) -> UntypedResource

Creates new untyped resource in pending state using the given path and type uuid.

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

where T: ResourceData,

Creates new untyped resource in ok (fully loaded) state using the given data of any type, that implements ResourceData trait.

pub fn new_load_error( kind: ResourceKind, error: LoadError, type_uuid: Uuid ) -> UntypedResource

Creates new untyped resource in error state.

pub fn type_uuid(&self) -> Uuid

Returns actual unique type id of underlying resource data.

pub fn is_loading(&self) -> bool

Returns true if the resource is still loading.

pub fn is_embedded(&self) -> bool

Returns true if the resource is procedural (its data is generated at runtime, not stored in an external file).

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 path of the untyped resource.

pub fn set_kind(&self, new_kind: ResourceKind)

Set a new path for the untyped resource.

pub fn try_cast<T>(&self) -> Option<Resource<T>>

where T: TypedResourceData,

Tries to cast untyped resource to a particular type.

pub fn commit(&self, state: ResourceState)

Changes ResourceState::Pending state to ResourceState::Ok(data) with given data. Additionally it wakes all futures.

pub fn commit_ok<T>(&self, data: T)

where T: ResourceData,

Changes internal state to ResourceState::Ok

pub fn commit_error<E>(&self, error: E)

where E: ResourceLoadError,

Changes internal state to ResourceState::LoadError.

Trait Implementations

impl Clone for UntypedResource

fn clone(&self) -> UntypedResource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UntypedResource

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

Formats the value using the given formatter.

impl Default for UntypedResource

fn default() -> UntypedResource

Returns the “default value” for a type.

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

where T: TypedResourceData,

fn from(untyped: UntypedResource) -> Resource<T>

Converts to this type from the input type.

impl Future for UntypedResource

type Output = Result<UntypedResource, LoadError>

The type of value produced on completion.

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

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

impl Hash for UntypedResource

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, 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 PartialEq for UntypedResource

fn eq(&self, other: &UntypedResource) -> 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 Reflect for UntypedResource

where UntypedResource: 'static, Arc<Mutex<RawMutex, ResourceHeader>>: Reflect,

fn source_path() -> &'static str

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

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

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

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

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

fn into_any(self: Box<UntypedResource>) -> 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 + 'static)))

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

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

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

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

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

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

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

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 TypeUuidProvider for UntypedResource

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for UntypedResource

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl Eq for UntypedResource