Struct bevy::asset::prelude::HandleUntyped

pub struct HandleUntyped {
    pub id: HandleId,
    /* private fields */
}

A non-generic version of Handle.

This allows handles to be mingled in a cross asset context. For example, storing Handle<A> and Handle<B> in the same HashSet<HandleUntyped>.

To convert back to a typed handle, use the typed method.

Fields

id: HandleId

An unique identifier to an Asset.

Implementations

impl HandleUntyped

pub const fn weak_from_u64(uuid: Uuid, id: u64) -> HandleUntyped

Creates a weak untyped handle with an arbitrary id.

pub fn weak(id: HandleId) -> HandleUntyped

Create a weak, untyped handle into an Asset identified by id.

pub fn clone_weak(&self) -> HandleUntyped

Creates a weak copy of this handle.

pub fn is_weak(&self) -> bool

Returns true if this is a weak handle.

pub fn is_strong(&self) -> bool

Returns true if this is a strong handle.

pub fn typed_weak<T>(&self) -> Handle<T>where
    T: Asset,

Create a weak typed Handle from this handle.

If this handle is strong and dropped, there is no guarantee that the asset will still be available (if only the returned handle is kept)

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

Converts this handle into a typed Handle of an Asset T.

The new handle will maintain the Strong or Weak status of the current handle.

Panics

Will panic if type T doesn’t match this handle’s actual asset type.

Trait Implementations

impl Clone for HandleUntyped

fn clone(&self) -> HandleUntyped

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HandleUntyped

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

Formats the value using the given formatter.

impl Drop for HandleUntyped

fn drop(&mut self)

Executes the destructor for this type.

impl From<&HandleUntyped> for HandleId

fn from(value: &HandleUntyped) -> HandleId

Converts to this type from the input type.

impl<A> From<Handle<A>> for HandleUntypedwhere
    A: Asset,

fn from(handle: Handle<A>) -> HandleUntyped

Converts to this type from the input type.

impl From<HandleUntyped> for HandleId

fn from(value: HandleUntyped) -> HandleId

Converts to this type from the input type.

impl Hash for HandleUntyped

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<HandleUntyped> for HandleUntyped

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