Struct Resource 

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

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

Default State

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

Implementations

impl<T> Resource<T>

where T: Debug,

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

impl<T> Resource<T>

where T: TypedResourceData,

pub fn summary(&self) -> String

Create a summary of this resource handle, wht UUID, embedded/external, and Ok, Pending, Error, etc.

pub fn new_pending(uuid: Uuid, kind: ResourceKind) -> Resource<T>

Creates new resource in pending state.

pub fn new_ok(resource_uuid: Uuid, kind: ResourceKind, data: T) -> Resource<T>

Creates new resource in ok state (fully loaded).

pub fn new_embedded(data: T) -> Resource<T>

Creates a new embedded resource in ok state (fully loaded).

pub fn new_load_error( kind: ResourceKind, path: PathBuf, error: LoadError, ) -> Resource<T>

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<'_, RawMutex, ResourceHeader>

Locks the resource and provides access to its header. See ResourceHeader docs for more info.

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

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

pub fn kind(&self) -> ResourceKind

Returns kind of the resource, if the resource is registered.

pub fn resource_uuid(&self) -> Uuid

The UUID of the resource. All resources must have a UUID, even if they are not loaded because the UUID is how the resource manager knows the path to load from.

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 get a reference to the resource data. The returned object implements Deref and DerefMut traits, and basically acts like a reference to the resource value.

Panic

An attempt to dereference the returned object will result in panic if the resource is not loaded yet, or there was a loading error. Usually this is ok because you should chain this call like this resource.await?.data_ref(). Every resource implements Future trait, and it returns Result, so if you’ll await the future then you’ll get Result, so call to data_ref will be fine.

You can also use [ResourceDataRef::as_loaded_ref] and [ResourceDataRef::as_loaded_mut] methods that perform checked access to the resource internals.

pub fn save(&self, path: &Path) -> Result<(), Box<dyn Error>>

Tries to save the resource to the specified path.

Trait Implementations

impl<T> AsRef<UntypedResource> for Resource<T>

where T: TypedResourceData,

fn as_ref(&self) -> &UntypedResource

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Resource<T>

where T: Debug,

fn clone(&self) -> Resource<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Resource<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Resource<T>

where T: TypedResourceData,

fn default() -> Resource<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Resource<T>

where T: Debug + TypedResourceData,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Resource<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Resource<Texture>> for MaterialResourceBinding

fn from(value: Resource<Texture>) -> MaterialResourceBinding

Converts to this type from the input type.

impl From<Resource<Texture>> for StyleProperty

fn from(value: Resource<Texture>) -> StyleProperty

Converts to this type from the input 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<T> From<Uuid> for Resource<T>

where T: TypedResourceData,

fn from(uuid: Uuid) -> Resource<T>

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 Resource<T>>, cx: &mut Context<'_>, ) -> Poll<<Resource<T> as Future>::Output>

Attempts 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>(&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 HrirSphereResourceExt for Resource<HrirSphereResourceData>

fn from_hrir_sphere( hrir_sphere: HrirSphere, kind: ResourceKind, ) -> Resource<HrirSphereResourceData>

Creates a new HRIR sphere resource directly from pre-loaded HRIR sphere. It could be used if you do not use a resource manager, but want to load HRIR spheres manually.

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

where T: TypedResourceData,

fn into(self) -> UntypedResource

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

impl IntoPrimitive<Resource<Texture>> for StyleProperty

fn into_primitive(self) -> Option<Resource<Texture>>

Tries to convert self into a primitive value T.

impl MaterialResourceExtension for Resource<Material>

fn new(material: Material) -> Resource<Material>

Creates a new material resource.

fn deep_copy(&self) -> Resource<Material>

Creates a deep copy of the material resource.

fn deep_copy_as_embedded(&self) -> Resource<Material>

Creates a deep copy of the material resource and marks it as procedural.

impl<T> PartialEq for Resource<T>

where T: TypedResourceData,

fn eq(&self, other: &Resource<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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: Debug, Resource<T>: 'static,

fn source_path() -> &'static str

fn try_clone_box(&self) -> Option<Box<dyn Reflect>>

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

fn derived_types() -> &'static [TypeId]

fn query_derived_types(&self) -> &'static [TypeId]

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_ref(&self, func: &mut dyn FnMut(&[FieldRef<'_, '_>]))

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

fn into_any(self: Box<Resource<T>>) -> 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 set_field( &mut self, field_name: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, SetFieldError>), )

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

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

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

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

impl<T> Serialize for Resource<T>

where T: Debug + TypedResourceData,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ShaderResourceExtension for Resource<Shader>

fn from_str( id: Uuid, str: &str, kind: ResourceKind, ) -> Result<Resource<Shader>, ShaderError>

Creates new shader from given string. Input string must have the format defined in examples for ShaderResource.

fn standard() -> Resource<Shader>

Returns an instance of standard shader.

fn standard_2d() -> Resource<Shader>

Returns an instance of standard 2D shader.

fn standard_particle_system() -> Resource<Shader>

Returns an instance of standard particle system shader.

fn standard_sprite() -> Resource<Shader>

Returns an instance of standard sprite shader.

fn standard_terrain() -> Resource<Shader>

Returns an instance of standard terrain shader.

fn standard_tile() -> Resource<Shader>

Returns an instance of standard tile shader.

fn standard_twosides() -> Resource<Shader>

Returns an instance of standard two-sides terrain shader.

fn standard_widget() -> Resource<Shader>

Returns an instance of standard widget shader.

fn standard_shaders() -> [&'static BuiltInResource<Shader>; 8]

Returns a list of standard shader.

impl SoundBufferResourceExtension for Resource<SoundBuffer>

fn new_streaming( data_source: DataSource, ) -> Result<Resource<SoundBuffer>, SoundBufferResourceLoadError>

Tries to create new streaming sound buffer from a given data source.

fn new_generic( data_source: DataSource, ) -> Result<Resource<SoundBuffer>, SoundBufferResourceLoadError>

Tries to create new generic sound buffer from a given data source.

impl StyleResourceExt for Resource<Style>

fn set( &self, name: impl Into<ImmutableString>, property: impl Into<StyleProperty>, )

Same as Style::set.

fn get<P>(&self, name: impl Into<ImmutableString>) -> Option<P>

where StyleProperty: IntoPrimitive<P>,

Same as Style::get.

fn get_or<P>(&self, name: impl Into<ImmutableString>, default: P) -> P

where StyleProperty: IntoPrimitive<P>,

Same as Style::get_or.

fn get_or_default<P>(&self, name: impl Into<ImmutableString>) -> P

where P: Default, StyleProperty: IntoPrimitive<P>,

Same as Style::get_or_default.

fn property<P>(&self, name: impl Into<ImmutableString>) -> StyledProperty<P>

where P: Default, StyleProperty: IntoPrimitive<P>,

Same as Style::property.

impl TextureResourceExtension for Resource<Texture>

fn new_render_target(width: u32, height: u32) -> Resource<Texture>

Creates new render target. This method automatically configures GPU texture to correct settings, after render target was created, it must not be modified, otherwise result is undefined.

fn new_cube_render_target(size: u32) -> Resource<Texture>

Creates a new cube map render target. This method automatically configures GPU texture to correct settings. After the render target was created, it must not be modified. Otherwise the result is undefined. Cube map contains six images

fn new_render_target_with_format( width: u32, height: u32, pixel_kind: TexturePixelKind, ) -> Resource<Texture>

Creates new render target with the specified pixel kind. This method automatically configures GPU texture to correct settings, after render target was created, it must not be modified, otherwise result is undefined.

fn load_from_memory( resource_uuid: Uuid, kind: ResourceKind, data: &[u8], import_options: TextureImportOptions, ) -> Result<Resource<Texture>, TextureError>

Tries to load a texture from given data. Use this method if you want to load a texture from embedded data.

fn from_bytes( resource_uuid: Uuid, kind: TextureKind, pixel_kind: TexturePixelKind, bytes: Vec<u8>, resource_kind: ResourceKind, ) -> Option<Resource<Texture>>

Tries to create new texture from given parameters, it may fail only if size of data passed in does not match with required.

fn deep_clone(&self) -> Resource<Texture>

Creates a deep clone of the texture. Unlike TextureResource::clone, this method clones the actual texture data, which could be slow.

impl<T> TypeUuidProvider for Resource<T>

where T: TypedResourceData,

fn type_uuid() -> Uuid

Return type UUID.

impl UserInterfaceResourceExtension for Resource<UserInterface>

fn instantiate( &self, ui: &mut UserInterface, ) -> (Handle<UiNode>, NodeHandleMap<UiNode>)

impl<T> Visit for Resource<T>

where T: TypedResourceData,

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

where T: TypedResourceData,