Struct bevy_asset::ReflectAsset

source ·
pub struct ReflectAsset { /* private fields */ }
Expand description

Type data for the TypeRegistry used to operate on reflected Assets.

This type provides similar methods to Assets<T> like get, add and remove, but can be used in situations where you don’t know which asset type T you want until runtime.

ReflectAsset can be obtained via TypeRegistration::data if the asset was registered using register_asset_reflect.

Implementations§

source§

impl ReflectAsset

source

pub fn handle_type_id(&self) -> TypeId

The TypeId of the Handle<T> for this asset

source

pub fn assets_resource_type_id(&self) -> TypeId

The TypeId of the Assets<T> resource

source

pub fn get<'w>( &self, world: &'w World, handle: UntypedHandle ) -> Option<&'w dyn Reflect>

Equivalent of Assets::get

source

pub fn get_mut<'w>( &self, world: &'w mut World, handle: UntypedHandle ) -> Option<&'w mut dyn Reflect>

Equivalent of Assets::get_mut

source

pub unsafe fn get_unchecked_mut<'w>( &self, world: UnsafeWorldCell<'w>, handle: UntypedHandle ) -> Option<&'w mut dyn Reflect>

Equivalent of Assets::get_mut, but works with an UnsafeWorldCell.

Only use this method when you have ensured that you are the only one with access to the Assets resource of the asset type. Furthermore, this does not allow you to have look up two distinct handles, you can only have at most one alive at the same time. This means that this is not allowed:

let unsafe_world_cell = world.as_unsafe_world_cell();
let a = unsafe { reflect_asset.get_unchecked_mut(unsafe_world_cell, handle_1).unwrap() };
let b = unsafe { reflect_asset.get_unchecked_mut(unsafe_world_cell, handle_2).unwrap() };
// ^ not allowed, two mutable references through the same asset resource, even though the
// handles are distinct

println!("a = {a:?}, b = {b:?}");
§Safety

This method does not prevent you from having two mutable pointers to the same data, violating Rust’s aliasing rules. To avoid this:

  • Only call this method if you know that the UnsafeWorldCell may be used to access the corresponding Assets<T>
  • Don’t call this method more than once in the same scope.
source

pub fn add(&self, world: &mut World, value: &dyn Reflect) -> UntypedHandle

Equivalent of Assets::add

source

pub fn insert( &self, world: &mut World, handle: UntypedHandle, value: &dyn Reflect )

Equivalent of Assets::insert

source

pub fn remove( &self, world: &mut World, handle: UntypedHandle ) -> Option<Box<dyn Reflect>>

Equivalent of Assets::remove

source

pub fn len(&self, world: &World) -> usize

Equivalent of Assets::len

source

pub fn is_empty(&self, world: &World) -> bool

Equivalent of Assets::is_empty

source

pub fn ids<'w>( &self, world: &'w World ) -> impl Iterator<Item = UntypedAssetId> + 'w

Equivalent of Assets::ids

Trait Implementations§

source§

impl Clone for ReflectAsset

source§

fn clone(&self) -> ReflectAsset

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<A: Asset + FromReflect> FromType<A> for ReflectAsset

source§

fn from_type() -> Self

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ConditionalSend for T
where T: Send,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,