Enum bevy::asset::UntypedHandle

pub enum UntypedHandle {
    Strong(Arc<StrongHandle>),
    Weak(UntypedAssetId),
}

An untyped variant of Handle, which internally stores the Asset type information at runtime as a TypeId instead of encoding it in the compile-time type. This allows handles across Asset types to be stored together and compared.

See Handle for more information.

Variants

Strong(Arc<StrongHandle>)

Weak(UntypedAssetId)

Implementations

impl UntypedHandle

pub fn id(&self) -> UntypedAssetId

Returns the UntypedAssetId for the referenced asset.

pub fn path(&self) -> Option<&AssetPath<'static>>

Returns the path if this is (1) a strong handle and (2) the asset has a path

pub fn clone_weak(&self) -> UntypedHandle

Creates an UntypedHandle::Weak clone of this UntypedHandle, which will not keep the referenced Asset alive.

pub fn type_id(&self) -> TypeId

Returns the TypeId of the referenced Asset.

pub fn typed_unchecked<A>(self) -> Handle<A>where A: Asset,

Converts to a typed Handle. This will not check if the target Handle type matches.

pub fn typed_debug_checked<A>(self) -> Handle<A>where A: Asset,

Converts to a typed Handle. This will check the type when compiled with debug asserts, but it will not check if the target Handle type matches in release builds. Use this as an optimization when you want some degree of validation at dev-time, but you are also very certain that the type actually matches.

pub fn typed<A>(self) -> Handle<A>where A: Asset,

Converts to a typed Handle. This will panic if the internal TypeId does not match the given asset type A

pub fn meta_transform( &self ) -> Option<&Box<dyn Fn(&mut (dyn AssetMetaDyn + 'static)) + Sync + Send>>

The “meta transform” for the strong handle. This will only be Some if the handle is strong and there is a meta transform associated with it.

Trait Implementations

impl Clone for UntypedHandle

fn clone(&self) -> UntypedHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UntypedHandle

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for UntypedHandle

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

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

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Eq for UntypedHandle