Struct bevy::ecs::world::OccupiedEntry

pub struct OccupiedEntry<'w, 'a, T>
where
    T: Component,
{ /* private fields */ }

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

impl<'w, 'a, T> OccupiedEntry<'w, 'a, T>

where T: Component,

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);
}

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

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

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

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