Struct bevy_ecs::world::OccupiedEntry
source · pub struct OccupiedEntry<'w, 'a, T: Component> { /* private fields */ }
Expand description
A view into an occupied entry in a EntityWorldMut
. It is part of the Entry
enum.
The contained entity must have the component type parameter if we have this struct.
Implementations§
source§impl<'w, 'a, T: Component> OccupiedEntry<'w, 'a, T>
impl<'w, 'a, T: Component> OccupiedEntry<'w, 'a, T>
sourcepub fn get(&self) -> &T
pub fn get(&self) -> &T
Gets a reference to the component in the entry.
§Examples
#[derive(Component, Default, Clone, Copy, Debug, PartialEq)]
struct Comp(u32);
let mut entity = world.spawn(Comp(5));
if let Entry::Occupied(o) = entity.entry::<Comp>() {
assert_eq!(o.get().0, 5);
}
sourcepub fn get_mut(&mut self) -> Mut<'_, T>
pub fn get_mut(&mut self) -> Mut<'_, T>
Gets a mutable reference to the component in the entry.
If you need a reference to the OccupiedEntry
which may outlive the destruction of
the Entry
value, see into_mut
.
§Examples
#[derive(Component, Default, Clone, Copy, Debug, PartialEq)]
struct Comp(u32);
let mut entity = world.spawn(Comp(5));
if let Entry::Occupied(mut o) = entity.entry::<Comp>() {
o.get_mut().0 += 10;
assert_eq!(o.get().0, 15);
// We can use the same Entry multiple times.
o.get_mut().0 += 2
}
assert_eq!(world.query::<&Comp>().single(&world).0, 17);
sourcepub fn into_mut(self) -> Mut<'a, T>
pub fn into_mut(self) -> Mut<'a, T>
Converts the OccupiedEntry
into a mutable reference to the value in the entry with
a lifetime bound to the EntityWorldMut
.
If you need multiple references to the OccupiedEntry
, see get_mut
.
§Examples
#[derive(Component, Default, Clone, Copy, Debug, PartialEq)]
struct Comp(u32);
let mut entity = world.spawn(Comp(5));
if let Entry::Occupied(o) = entity.entry::<Comp>() {
o.into_mut().0 += 10;
}
assert_eq!(world.query::<&Comp>().single(&world).0, 15);
sourcepub fn insert(&mut self, component: T)
pub fn insert(&mut self, component: T)
Replaces the component of the entry.
§Examples
#[derive(Component, Default, Clone, Copy, Debug, PartialEq)]
struct Comp(u32);
let mut entity = world.spawn(Comp(5));
if let Entry::Occupied(mut o) = entity.entry::<Comp>() {
o.insert(Comp(10));
}
assert_eq!(world.query::<&Comp>().single(&world).0, 10);
sourcepub fn take(self) -> T
pub fn take(self) -> T
Removes the component from the entry and returns it.
§Examples
#[derive(Component, Default, Clone, Copy, Debug, PartialEq)]
struct Comp(u32);
let mut entity = world.spawn(Comp(5));
if let Entry::Occupied(o) = entity.entry::<Comp>() {
assert_eq!(o.take(), Comp(5));
}
assert_eq!(world.query::<&Comp>().iter(&world).len(), 0);
Auto Trait Implementations§
impl<'w, 'a, T> Freeze for OccupiedEntry<'w, 'a, T>
impl<'w, 'a, T> !RefUnwindSafe for OccupiedEntry<'w, 'a, T>
impl<'w, 'a, T> Send for OccupiedEntry<'w, 'a, T>
impl<'w, 'a, T> Sync for OccupiedEntry<'w, 'a, T>
impl<'w, 'a, T> Unpin for OccupiedEntry<'w, 'a, T>where
T: Unpin,
impl<'w, 'a, T> !UnwindSafe for OccupiedEntry<'w, 'a, T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.