Struct shipyard::AllStorages

pub struct AllStorages { /* fields omitted */ }

Contains all components present in the World.

Implementations

impl AllStorages

pub fn delete(&mut self, entity: EntityId) -> bool

Delete an entity and all its components. Returns true if entity was alive.

Example

let world = World::new();

let (mut entities, mut usizes, mut u32s) = world.borrow::<(EntitiesMut, &mut usize, &mut u32)>();

let entity1 = entities.add_entity((&mut usizes, &mut u32s), (0usize, 1u32));
let entity2 = entities.add_entity((&mut usizes, &mut u32s), (2usize, 3u32));

drop((entities, usizes, u32s));
world.run::<AllStorages, _, _>(|mut all_storages| {
    all_storages.delete(entity1);
});

world.run::<(&usize, &u32), _, _>(|(usizes, u32s)| {
    assert!((&usizes).get(entity1).is_err());
    assert!((&u32s).get(entity1).is_err());
    assert_eq!(usizes.get(entity2), Ok(&2));
    assert_eq!(u32s.get(entity2), Ok(&3));
});

pub fn strip(&mut self, entity: EntityId)

Deletes all components from an entity without deleting it.

pub fn clear(&mut self)

Deletes all entities and their components.

pub fn try_borrow<'a, C: StorageBorrow<'a>>(
    &'a self
) -> Result<<C as StorageBorrow<'a>>::View, GetStorage>

Borrows the requested storage, if it doesn’t exist it’ll get created.

You can use:

• &T for a shared access to T storage
• &mut T for an exclusive access to T storage
• Entities for a shared access to the entity storage
• EntitiesMut for an exclusive reference to the entity storage
• AllStorages for an exclusive access to the storage of all components
• Unique<&T> for a shared access to a T unique storage
• Unique<&mut T> for an exclusive access to a T unique storage
• ThreadPool for a shared access to the ThreadPool used by the World
• NonSend: must activate the non_send feature
• NonSync: must activate the non_sync feature
• NonSendSync: must activate the non_send and non_sync features

Example

let world = World::new();
let all_storages = world.borrow::<AllStorages>();
let u32s = all_storages.try_borrow::<&u32>().unwrap();

pub fn borrow<'a, C: StorageBorrow<'a>>(
    &'a self
) -> <C as StorageBorrow<'a>>::View

Borrows the requested storage, if it doesn’t exist it’ll get created.
Unwraps errors.

You can use:

• &T for a shared access to T storage
• &mut T for an exclusive access to T storage
• Entities for a shared access to the entity storage
• EntitiesMut for an exclusive reference to the entity storage
• AllStorages for an exclusive access to the storage of all components
• Unique<&T> for a shared access to a T unique storage
• Unique<&mut T> for an exclusive access to a T unique storage
• ThreadPool for a shared access to the ThreadPool used by the World
• NonSend: must activate the non_send feature
• NonSync: must activate the non_sync feature
• NonSendSync: must activate the non_send and non_sync features

Example

let world = World::new();
let all_storages = world.borrow::<AllStorages>();
let u32s = all_storages.borrow::<&u32>();

Trait Implementations

impl Default for AllStorages

fn default() -> Self

Returns the “default value” for a type.

impl<'a> TryFrom<&'a AllStorages> for EntitiesView<'a>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a AllStorages> for EntitiesViewMut<'a>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T: 'static + Send + Sync> TryFrom<&'a AllStorages> for View<'a, T>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T: 'static + Send + Sync> TryFrom<&'a AllStorages> for ViewMut<'a, T>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T: 'static + Send + Sync> TryFrom<&'a AllStorages> for UniqueView<'a, T>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T: 'static + Send + Sync> TryFrom<&'a AllStorages> for UniqueViewMut<'a, T>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.