Enum bevy_asset::AssetId
source · pub enum AssetId<A: Asset> {
Index {
index: AssetIndex,
marker: PhantomData<fn() -> A>,
},
Uuid {
uuid: Uuid,
},
}
Expand description
A unique runtime-only identifier for an Asset
. This is cheap to Copy
/Clone
and is not directly tied to the
lifetime of the Asset. This means it can point to an Asset
that no longer exists.
For an identifier tied to the lifetime of an asset, see Handle
.
For an “untyped” / “generic-less” id, see UntypedAssetId
.
Variants§
Index
A small / efficient runtime identifier that can be used to efficiently look up an asset stored in Assets
. This is
the “default” identifier used for assets. The alternative(s) (ex: AssetId::Uuid
) will only be used if assets are
explicitly registered that way.
Uuid
A stable-across-runs / const asset identifier. This will only be used if an asset is explicitly registered in Assets
with one.
Implementations§
source§impl<A: Asset> AssetId<A>
impl<A: Asset> AssetId<A>
sourcepub const DEFAULT_UUID: Uuid = _
pub const DEFAULT_UUID: Uuid = _
sourcepub const INVALID_UUID: Uuid = _
pub const INVALID_UUID: Uuid = _
This asset id should never be valid. Assigning a value to this in Assets
will
produce undefined behavior, so don’t do it!
sourcepub const fn invalid() -> Self
pub const fn invalid() -> Self
Returns an AssetId
with Self::INVALID_UUID
, which should never be assigned to.
sourcepub fn untyped(self) -> UntypedAssetId
pub fn untyped(self) -> UntypedAssetId
Converts this to an “untyped” / “generic-less” Asset
identifier that stores the type information
inside the UntypedAssetId
.
Trait Implementations§
source§impl<'de, A: Asset> Deserialize<'de> for AssetId<A>
impl<'de, A: Asset> Deserialize<'de> for AssetId<A>
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl<A> Enum for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
impl<A> Enum for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, __name_param: &str) -> Option<&dyn Reflect>
fn field(&self, __name_param: &str) -> Option<&dyn Reflect>
source§fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>
fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>
source§fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>
source§fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>
source§fn index_of(&self, __name_param: &str) -> Option<usize>
fn index_of(&self, __name_param: &str) -> Option<usize>
source§fn name_at(&self, __index_param: usize) -> Option<&str>
fn name_at(&self, __index_param: usize) -> Option<&str>
source§fn iter_fields(&self) -> VariantFieldIter<'_>
fn iter_fields(&self) -> VariantFieldIter<'_>
source§fn variant_name(&self) -> &str
fn variant_name(&self) -> &str
source§fn variant_index(&self) -> usize
fn variant_index(&self) -> usize
source§fn variant_type(&self) -> VariantType
fn variant_type(&self) -> VariantType
fn clone_dynamic(&self) -> DynamicEnum
source§fn is_variant(&self, variant_type: VariantType) -> bool
fn is_variant(&self, variant_type: VariantType) -> bool
source§fn variant_path(&self) -> String
fn variant_path(&self) -> String
source§impl<A: Asset> From<AssetIndex> for AssetId<A>
impl<A: Asset> From<AssetIndex> for AssetId<A>
source§fn from(value: AssetIndex) -> Self
fn from(value: AssetIndex) -> Self
source§impl<A> FromReflect for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
impl<A> FromReflect for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(__param0: &dyn Reflect) -> Option<Self>
fn from_reflect(__param0: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl<A> GetTypeRegistration for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
impl<A> GetTypeRegistration for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl<A: Asset> Ord for AssetId<A>
impl<A: Asset> Ord for AssetId<A>
source§impl<A: Asset> PartialEq<AssetId<A>> for UntypedAssetId
impl<A: Asset> PartialEq<AssetId<A>> for UntypedAssetId
source§impl<A: Asset> PartialEq<UntypedAssetId> for AssetId<A>
impl<A: Asset> PartialEq<UntypedAssetId> for AssetId<A>
source§fn eq(&self, other: &UntypedAssetId) -> bool
fn eq(&self, other: &UntypedAssetId) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<A: Asset> PartialEq for AssetId<A>
impl<A: Asset> PartialEq for AssetId<A>
source§impl<A: Asset> PartialOrd<AssetId<A>> for UntypedAssetId
impl<A: Asset> PartialOrd<AssetId<A>> for UntypedAssetId
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<A: Asset> PartialOrd<UntypedAssetId> for AssetId<A>
impl<A: Asset> PartialOrd<UntypedAssetId> for AssetId<A>
source§fn partial_cmp(&self, other: &UntypedAssetId) -> Option<Ordering>
fn partial_cmp(&self, other: &UntypedAssetId) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<A: Asset> PartialOrd for AssetId<A>
impl<A: Asset> PartialOrd for AssetId<A>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<A> Reflect for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
impl<A> Reflect for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(
&mut self,
__value_param: Box<dyn Reflect>
) -> Result<(), Box<dyn Reflect>>
fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl<A: Asset> TryFrom<UntypedAssetId> for AssetId<A>
impl<A: Asset> TryFrom<UntypedAssetId> for AssetId<A>
§type Error = UntypedAssetIdConversionError
type Error = UntypedAssetIdConversionError
source§impl<A> TypePath for AssetId<A>
impl<A> TypePath for AssetId<A>
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl<A> Typed for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
impl<A> Typed for AssetId<A>where
Self: Any + Send + Sync,
A: TypePath + Asset,
AssetIndex: FromReflect + TypePath + RegisterForReflection,
Uuid: FromReflect + TypePath + RegisterForReflection,
impl<A: Asset> Copy for AssetId<A>
impl<A: Asset> Eq for AssetId<A>
Auto Trait Implementations§
impl<A> Freeze for AssetId<A>
impl<A> RefUnwindSafe for AssetId<A>
impl<A> Send for AssetId<A>
impl<A> Sync for AssetId<A>
impl<A> Unpin for AssetId<A>
impl<A> UnwindSafe for AssetId<A>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more