forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Remove EntityMut::get_unchecked (#4547)

Browse Source 
The only way to soundly use this API is already encapsulated within `EntityMut::get`, so this api is removed.

# Migration guide

Replace calls to `EntityMut::get_unchecked` with calls to `EntityMut::get`.
This commit is contained in:
TheRawMeatball 2022-04-22 20:06:41 +00:00
parent 7a0f46c21b
commit 0fdb45ce90
1 changed files with 4 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
crates/bevy_ecs/src/world/entity_ref.rs
View File

@ -154,7 +154,10 @@ impl<'w> EntityMut<'w> {
#[inline] #[inline]
pub fn get<T: Component>(&self) -> Option<&'_ T> { pub fn get<T: Component>(&self) -> Option<&'_ T> {
// SAFE: lifetimes enforce correct usage of returned borrow // SAFE: lifetimes enforce correct usage of returned borrow
unsafe { self.get_unchecked::<T>() } unsafe {
get_component_with_type(self.world, TypeId::of::<T>(), self.entity, self.location)
.map(|value| &*value.cast::<T>())
}
} }
#[inline] #[inline]
@ -163,23 +166,6 @@ impl<'w> EntityMut<'w> {
unsafe { self.get_unchecked_mut::<T>() } unsafe { self.get_unchecked_mut::<T>() }
} }
/// Gets an immutable reference to the component of type `T` associated with
/// this entity without ensuring there are no unique borrows active and without
/// ensuring that the returned reference will stay valid.
///
/// # Safety
///
/// - The returned reference must never alias a mutable borrow of this component.
/// - The returned reference must not be used after this component is moved which
/// may happen from **any** `insert_component`, `remove_component` or `despawn`
/// operation on this world (non-exhaustive list).
#[inline]
pub unsafe fn get_unchecked<T: Component>(&self) -> Option<&'w T> {
// SAFE: entity location is valid and returned component is of type T
get_component_with_type(self.world, TypeId::of::<T>(), self.entity, self.location)
.map(|value| &*value.cast::<T>())
}
/// Gets a mutable reference to the component of type `T` associated with /// Gets a mutable reference to the component of type `T` associated with
/// this entity without ensuring there are no other borrows active and without /// this entity without ensuring there are no other borrows active and without
/// ensuring that the returned reference will stay valid. /// ensuring that the returned reference will stay valid.