Enum bevy::asset::UntypedAssetId

pub enum UntypedAssetId {
    Index {
        type_id: TypeId,
        index: AssetIndex,
    },
    Uuid {
        type_id: TypeId,
        uuid: Uuid,
    },
}

An “untyped” / “generic-less” Asset identifier that behaves much like AssetId, but stores the Asset type information at runtime instead of compile-time. This increases the size of the type, but it enables storing asset ids across asset types together and enables comparisons between them.

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: UntypedAssetId::Uuid) will only be used if assets are explicitly registered that way.

Fields

type_id: TypeId

index: AssetIndex

Uuid

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

Fields

type_id: TypeId

uuid: Uuid

Implementations

impl UntypedAssetId

pub fn typed_unchecked<A>(self) -> AssetId<A>

where A: Asset,

Converts this to a “typed” AssetId without checking the stored type to see if it matches the target A Asset type. This should only be called if you are absolutely certain the asset type matches the stored type. And even then, you should consider using UntypedAssetId::typed_debug_checked instead.

Examples found in repository

examples/2d/texture_atlas.rs (line 213)

fn create_texture_atlas(
    folder: &LoadedFolder,
    padding: Option<UVec2>,
    sampling: Option<ImageSampler>,
    textures: &mut ResMut<Assets<Image>>,
) -> (TextureAtlasLayout, Handle<Image>) {
    // Build a texture atlas using the individual sprites
    let mut texture_atlas_builder =
        TextureAtlasBuilder::default().padding(padding.unwrap_or_default());
    for handle in folder.handles.iter() {
        let id = handle.id().typed_unchecked::<Image>();
        let Some(texture) = textures.get(id) else {
            warn!(
                "{:?} did not resolve to an `Image` asset.",
                handle.path().unwrap()
            );
            continue;
        };

        texture_atlas_builder.add_texture(Some(id), texture);
    }

    let (texture_atlas_layout, texture) = texture_atlas_builder.finish().unwrap();
    let texture = textures.add(texture);

    // Update the sampling settings of the texture atlas
    let image = textures.get_mut(&texture).unwrap();
    image.sampler = sampling.unwrap_or_default();

    (texture_atlas_layout, texture)
}

pub fn typed_debug_checked<A>(self) -> AssetId<A>

where A: Asset,

Converts this to a “typed” AssetId. When compiled in debug-mode it will check to see if the stored type matches the target A Asset type. When compiled in release-mode, this check will be skipped.

Panics

Panics if compiled in debug mode and the TypeId of A does not match the stored TypeId.

pub fn typed<A>(self) -> AssetId<A>

where A: Asset,

Converts this to a “typed” AssetId.

Panics

Panics if the TypeId of A does not match the stored type id.

pub fn try_typed<A>(self) -> Result<AssetId<A>, UntypedAssetIdConversionError>

where A: Asset,

Try to convert this to a “typed” AssetId.

pub fn type_id(&self) -> TypeId

Returns the stored TypeId of the referenced Asset.

Trait Implementations

impl Clone for UntypedAssetId

fn clone(&self) -> UntypedAssetId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UntypedAssetId

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

Formats the value using the given formatter.

impl Display for UntypedAssetId

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

Formats the value using the given formatter.

impl<A> From<&Handle<A>> for UntypedAssetId

where A: Asset,

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

Converts to this type from the input type.

impl From<&UntypedHandle> for UntypedAssetId

fn from(value: &UntypedHandle) -> UntypedAssetId

Converts to this type from the input type.

impl<A> From<AssetId<A>> for UntypedAssetId

where A: Asset,

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

Converts to this type from the input type.

impl<A> From<Handle<A>> for UntypedAssetId

where A: Asset,

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

Converts to this type from the input type.

impl From<UntypedHandle> for UntypedAssetId

fn from(value: UntypedHandle) -> UntypedAssetId

Converts to this type from the input type.

impl Hash for UntypedAssetId

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> PartialEq<AssetId<A>> for UntypedAssetId

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<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 PartialEq for UntypedAssetId

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 UntypedAssetId

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<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 PartialOrd for UntypedAssetId

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> 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 Copy for UntypedAssetId

impl Eq for UntypedAssetId