Enum bevy::asset::AssetId

pub enum AssetId<A>where
    A: Asset,{
    Index {
        index: AssetIndex,
        marker: PhantomData<fn() -> A>,
    },
    Uuid {
        uuid: Uuid,
    },
}

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

Fields

index: AssetIndex

marker: PhantomData<fn() -> A>

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

Fields

uuid: Uuid

A stable-across-runs / const asset identifier. This will only be used if an asset is explicitly registered in Assets with one.

Implementations

impl<A> AssetId<A>where A: Asset,

pub const DEFAULT_UUID: Uuid = _

The uuid for the default AssetId. It is valid to assign a value to this in Assets and by convention (where appropriate) assets should support this pattern.

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!

pub const fn invalid() -> AssetId<A>

Returns an AssetId with Self::INVALID_UUID, which should never be assigned to.

pub fn untyped(self) -> UntypedAssetId

Converts this to an “untyped” / “generic-less” Asset identifier that stores the type information inside the UntypedAssetId.

Trait Implementations

impl<A> Clone for AssetId<A>where A: Asset,

fn clone(&self) -> AssetId<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Debug for AssetId<A>where A: Asset,

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

Formats the value using the given formatter.

impl<A> Default for AssetId<A>where A: Asset,

fn default() -> AssetId<A>

Returns the “default value” for a type.

impl<A> Display for AssetId<A>where A: Asset,

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

Formats the value using the given formatter.

impl<A> Enum for AssetId<A>where A: Asset + TypePath, AssetIndex: FromReflect + TypePath, Uuid: FromReflect + TypePath, PhantomData<fn() -> A>: Any + Send + Sync,

fn field(&self, __name_param: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl<A> ExtractInstance for AssetId<A>where A: Asset,

type Query = &'static Handle<A>

ECS ReadOnlyWorldQueryData to fetch the components to extract.

type Filter = ()

Filters the entities with additional constraints.

fn extract( item: <<AssetId<A> as ExtractInstance>::Query as WorldQuery>::Item<'_> ) -> Option<AssetId<A>>

Defines how the component is transferred into the “render world”.

impl<A> From<&Handle<A>> for AssetId<A>where A: Asset,

fn from(value: &Handle<A>) -> AssetId<A>

Converts to this type from the input type.

impl<A> From<AssetId<A>> for UntypedAssetIdwhere A: Asset,

fn from(value: AssetId<A>) -> UntypedAssetId

Converts to this type from the input type.

impl<A> From<AssetIndex> for AssetId<A>where A: Asset,

fn from(value: AssetIndex) -> AssetId<A>

Converts to this type from the input type.

impl<A> From<Handle<A>> for AssetId<A>where A: Asset,

fn from(value: Handle<A>) -> AssetId<A>

Converts to this type from the input type.

impl<A> From<Uuid> for AssetId<A>where A: Asset,

fn from(value: Uuid) -> AssetId<A>

Converts to this type from the input type.

impl<A> FromReflect for AssetId<A>where A: Asset + TypePath, AssetIndex: FromReflect + TypePath, Uuid: FromReflect + TypePath, PhantomData<fn() -> A>: Any + Send + Sync + Default,

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<AssetId<A>>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect, Global> ) -> Result<Self, Box<dyn Reflect, Global>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<A> GetTypeRegistration for AssetId<A>where A: Asset + TypePath, AssetIndex: FromReflect + TypePath, Uuid: FromReflect + TypePath, PhantomData<fn() -> A>: Any + Send + Sync,

fn get_type_registration() -> TypeRegistration

impl<A> Hash for AssetId<A>where A: Asset,

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<A> Ord for AssetId<A>where A: Asset,

fn cmp(&self, other: &AssetId<A>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<A> PartialEq<AssetId<A>> for AssetId<A>where A: Asset,

fn eq(&self, other: &AssetId<A>) -> 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<A> PartialEq<AssetId<A>> for UntypedAssetIdwhere A: Asset,

fn eq(&self, other: &AssetId<A>) -> 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<A> PartialEq<UntypedAssetId> for AssetId<A>where A: Asset,

fn eq(&self, other: &UntypedAssetId) -> 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<A> PartialOrd<AssetId<A>> for AssetId<A>where A: Asset,

fn partial_cmp(&self, other: &AssetId<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> PartialOrd<AssetId<A>> for UntypedAssetIdwhere A: Asset,

fn partial_cmp(&self, other: &AssetId<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> PartialOrd<UntypedAssetId> for AssetId<A>where A: Asset,

fn partial_cmp(&self, other: &UntypedAssetId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> Reflect for AssetId<A>where A: Asset + TypePath, AssetIndex: FromReflect + TypePath, Uuid: FromReflect + TypePath, PhantomData<fn() -> A>: Any + Send + Sync,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<AssetId<A>, Global>) -> Box<dyn Any, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<AssetId<A>, Global>) -> Box<dyn Reflect, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect, Global>

Clones the value as a Reflect trait object.

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

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<AssetId<A>, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<A> TryFrom<UntypedAssetId> for AssetId<A>where A: Asset,

type Error = UntypedAssetIdConversionError

The type returned in the event of a conversion error.

fn try_from( value: UntypedAssetId ) -> Result<AssetId<A>, <AssetId<A> as TryFrom<UntypedAssetId>>::Error>

Performs the conversion.

impl<A> TypePath for AssetId<A>where A: Asset + TypePath, AssetIndex: FromReflect + TypePath, Uuid: FromReflect + TypePath, PhantomData<fn() -> A>: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<A> Typed for AssetId<A>where A: Asset + TypePath, AssetIndex: FromReflect + TypePath, Uuid: FromReflect + TypePath, PhantomData<fn() -> A>: Any + Send + Sync,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<A> Copy for AssetId<A>where A: Asset,

impl<A> Eq for AssetId<A>where A: Asset,