Struct AllStoragesView

pub struct AllStoragesView<'a>(/* private fields */);

Shared view over AllStorages.

Methods from Deref<Target = AllStorages>

pub fn add_unique<T: Send + Sync + Unique>(&self, component: T)

Adds a new unique storage, unique storages store exactly one T at any time.
To access a unique storage value, use UniqueView or UniqueViewMut.

Example

use shipyard::{AllStoragesViewMut, Unique, World};

#[derive(Unique)]
struct USIZE(usize);

let world = World::new();
let mut all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

all_storages.add_unique(USIZE(0));

pub fn add_unique_non_send<T: Sync + Unique>(&self, component: T)

Adds a new unique storage, unique storages store exactly one T at any time.
To access a unique storage value, use NonSend and UniqueViewMut or UniqueViewMut.
Does nothing if the storage already exists.

pub fn add_unique_non_sync<T: Send + Unique>(&self, component: T)

Adds a new unique storage, unique storages store exactly one T at any time.
To access a unique storage value, use NonSync and UniqueViewMut or UniqueViewMut.
Does nothing if the storage already exists.

pub fn add_unique_non_send_sync<T: Unique>(&self, component: T)

Adds a new unique storage, unique storages store exactly one T at any time.
To access a unique storage value, use NonSync and UniqueViewMut or UniqueViewMut.
Does nothing if the storage already exists.

pub fn remove_unique<T: Unique>(&self) -> Result<T, UniqueRemove>

Removes a unique storage.

Borrows

• T storage (exclusive)

Errors

• T storage borrow failed.
• T storage did not exist.

Example

use shipyard::{AllStoragesViewMut, Unique, World};

#[derive(Unique)]
struct USIZE(usize);

let world = World::new();
let mut all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

all_storages.add_unique(USIZE(0));
let i = all_storages.remove_unique::<USIZE>().unwrap();

pub fn borrow<V: Borrow>(&self) -> Result<V::View<'_>, GetStorage>

Borrows the requested storage(s), if it doesn’t exist it’ll get created.
You can use a tuple to get multiple storages at once.

You can use:

• View<T> for a shared access to T storage
• ViewMut<T> for an exclusive access to T storage
• EntitiesView for a shared access to the entity storage
• EntitiesViewMut for an exclusive reference to the entity storage
• UniqueView<T> for a shared access to a T unique storage
• UniqueViewMut<T> for an exclusive access to a T unique storage
• Option<V> with one or multiple views for fallible access to one or more storages
• This is supported on feature=“thread_local” only:
  • NonSend<View<T>> for a shared access to a T storage where T isn’t Send
  • NonSend<ViewMut<T>> for an exclusive access to a T storage where T isn’t Send
    NonSend and UniqueView/UniqueViewMut can be used together to access a !Send unique storage.
  • NonSync<View<T>> for a shared access to a T storage where T isn’t Sync
  • NonSync<ViewMut<T>> for an exclusive access to a T storage where T isn’t Sync
    NonSync and UniqueView/UniqueViewMut can be used together to access a !Sync unique storage.
  • NonSendSync<View<T>> for a shared access to a T storage where T isn’t Send nor Sync
  • NonSendSync<ViewMut<T>> for an exclusive access to a T storage where T isn’t Send nor Sync
    NonSendSync and UniqueView/UniqueViewMut can be used together to access a !Send + !Sync unique storage.

Borrows

• Storage (exclusive or shared)

Errors

• Storage borrow failed.
• Unique storage did not exist.

Example

use shipyard::{AllStoragesViewMut, Component, EntitiesView, View, ViewMut, World};

#[derive(Component)]
struct U32(u32);

#[derive(Component)]
struct USIZE(usize);

let world = World::new();

let all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

let u32s = all_storages.borrow::<View<U32>>().unwrap();
let (entities, mut usizes) = all_storages
    .borrow::<(EntitiesView, ViewMut<USIZE>)>()
    .unwrap();

pub fn run_with_data<Data, B, S: AllSystem<(Data,), B>>( &self, system: S, data: Data, ) -> S::Return

Borrows the requested storages, runs the function and evaluates to the function’s return value.
Data can be passed to the function, this always has to be a single type but you can use a tuple if needed.

You can use:

• View<T> for a shared access to T storage
• ViewMut<T> for an exclusive access to T storage
• EntitiesView for a shared access to the entity storage
• EntitiesViewMut for an exclusive reference to the entity storage
• UniqueView<T> for a shared access to a T unique storage
• UniqueViewMut<T> for an exclusive access to a T unique storage
• Option<V> with one or multiple views for fallible access to one or more storages
• This is supported on feature=“thread_local” only:
  • NonSend<View<T>> for a shared access to a T storage where T isn’t Send
  • NonSend<ViewMut<T>> for an exclusive access to a T storage where T isn’t Send
    NonSend and UniqueView/UniqueViewMut can be used together to access a !Send unique storage.
  • NonSync<View<T>> for a shared access to a T storage where T isn’t Sync
  • NonSync<ViewMut<T>> for an exclusive access to a T storage where T isn’t Sync
    NonSync and UniqueView/UniqueViewMut can be used together to access a !Sync unique storage.
  • NonSendSync<View<T>> for a shared access to a T storage where T isn’t Send nor Sync
  • NonSendSync<ViewMut<T>> for an exclusive access to a T storage where T isn’t Send nor Sync
    NonSendSync and UniqueView/UniqueViewMut can be used together to access a !Send + !Sync unique storage.

Borrows

• Storage (exclusive or shared)

Panics

• Storage borrow failed.
• Unique storage did not exist.
• Error returned by user.

pub fn run<B, S: AllSystem<(), B>>(&self, system: S) -> S::Return

Borrows the requested storages, runs the function and evaluates to the function’s return value.

You can use:

• View<T> for a shared access to T storage
• ViewMut<T> for an exclusive access to T storage
• EntitiesView for a shared access to the entity storage
• EntitiesViewMut for an exclusive reference to the entity storage
• UniqueView<T> for a shared access to a T unique storage
• UniqueViewMut<T> for an exclusive access to a T unique storage
• Option<V> with one or multiple views for fallible access to one or more storages
• This is supported on feature=“thread_local” only:
  • NonSend<View<T>> for a shared access to a T storage where T isn’t Send
  • NonSend<ViewMut<T>> for an exclusive access to a T storage where T isn’t Send
    NonSend and UniqueView/UniqueViewMut can be used together to access a !Send unique storage.
  • NonSync<View<T>> for a shared access to a T storage where T isn’t Sync
  • NonSync<ViewMut<T>> for an exclusive access to a T storage where T isn’t Sync
    NonSync and UniqueView/UniqueViewMut can be used together to access a !Sync unique storage.
  • NonSendSync<View<T>> for a shared access to a T storage where T isn’t Send nor Sync
  • NonSendSync<ViewMut<T>> for an exclusive access to a T storage where T isn’t Send nor Sync
    NonSendSync and UniqueView/UniqueViewMut can be used together to access a !Send + !Sync unique storage.

Borrows

• Storage (exclusive or shared)

Panics

• Storage borrow failed.
• Unique storage did not exist.
• Error returned by user.

Example

use shipyard::{AllStoragesViewMut, Component, View, ViewMut, World};

#[derive(Component)]
struct I32(i32);

#[derive(Component)]
struct U32(u32);

#[derive(Component)]
struct USIZE(usize);

fn sys1(i32s: View<I32>) -> i32 {
    0
}

let world = World::new();

let all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

all_storages
    .run(|usizes: View<USIZE>, mut u32s: ViewMut<U32>| {
        // -- snip --
    });

let i = all_storages.run(sys1);

pub fn memory_usage(&self) -> AllStoragesMemoryUsage<'_>

Displays storages memory information.

pub fn get_tracking_timestamp(&self) -> TrackingTimestamp

Returns a timestamp used to clear tracking information.

pub fn get<T: GetComponent>( &self, entity: EntityId, ) -> Result<T::Out<'_>, GetComponent>

Retrieve components of entity.

Multiple components can be queried at the same time using a tuple.

You can use:

• &T for a shared access to T component
• &mut T for an exclusive access to T component
• This is supported on feature=“thread_local” only:
• NonSend<&T> for a shared access to a T component where T isn’t Send
• NonSend<&mut T> for an exclusive access to a T component where T isn’t Send
• NonSync<&T> for a shared access to a T component where T isn’t Sync
• NonSync<&mut T> for an exclusive access to a T component where T isn’t Sync
• NonSendSync<&T> for a shared access to a T component where T isn’t Send nor Sync
• NonSendSync<&mut T> for an exclusive access to a T component where T isn’t Send nor Sync

Borrows

• AllStorages (shared) + storage (exclusive or shared)

Errors

• AllStorages borrow failed.
• Storage borrow failed.
• Entity does not have the component.

Example

use shipyard::{AllStoragesViewMut, Component, World};

#[derive(Component, Debug, PartialEq, Eq)]
struct U32(u32);

#[derive(Component, Debug, PartialEq, Eq)]
struct USIZE(usize);

let world = World::new();
let mut all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

let entity = all_storages.add_entity((USIZE(0), U32(1)));

let (i, j) = all_storages.get::<(&USIZE, &mut U32)>(entity).unwrap();

assert!(*i == &USIZE(0));
assert!(*j == &U32(1));

pub fn get_unique<T: GetUnique>(&self) -> Result<T::Out<'_>, GetStorage>

Retrieve a unique component.

You can use:

• &T for a shared access to T unique component
• &mut T for an exclusive access to T unique component
• This is supported on feature=“thread_local” only:
• NonSend<&T> for a shared access to a T unique component where T isn’t Send
• NonSend<&mut T> for an exclusive access to a T unique component where T isn’t Send
• NonSync<&T> for a shared access to a T unique component where T isn’t Sync
• NonSync<&mut T> for an exclusive access to a T unique component where T isn’t Sync
• NonSendSync<&T> for a shared access to a T unique component where T isn’t Send nor Sync
• NonSendSync<&mut T> for an exclusive access to a T unique component where T isn’t Send nor Sync

Borrows

• AllStorages (shared) + storage (exclusive or shared)

Errors

• AllStorages borrow failed.
• Storage borrow failed.

Example

use shipyard::{AllStoragesViewMut, Unique, World};

#[derive(Unique, Debug, PartialEq, Eq)]
struct U32(u32);

let world = World::new();
let mut all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

all_storages.add_unique(U32(0));

let i = all_storages.get_unique::<&U32>().unwrap();

assert!(*i == U32(0));

pub fn iter<'a, T: IterComponent>(&'a self) -> IntoIterRef<'a, T>

where <T as IterComponent>::Shiperator<'a>: ShiperatorCaptain + ShiperatorSailor,

Iterate components.

Multiple components can be iterated at the same time using a tuple.

You can use:

• &T for a shared access to T component
• &mut T for an exclusive access to T component
• This is supported on feature=“thread_local” only:
• NonSend<&T> for a shared access to a T component where T isn’t Send
• NonSend<&mut T> for an exclusive access to a T component where T isn’t Send
• NonSync<&T> for a shared access to a T component where T isn’t Sync
• NonSync<&mut T> for an exclusive access to a T component where T isn’t Sync
• NonSendSync<&T> for a shared access to a T component where T isn’t Send nor Sync
• NonSendSync<&mut T> for an exclusive access to a T component where T isn’t Send nor Sync

Borrows

• AllStorages (shared)

Panics

• AllStorages borrow failed.

Example

use shipyard::{AllStoragesViewMut, Component, World};

#[derive(Component, Debug, PartialEq, Eq)]
struct U32(u32);

#[derive(Component, Debug, PartialEq, Eq)]
struct USIZE(usize);

let world = World::new();
let mut all_storages = world.borrow::<AllStoragesViewMut>().unwrap();

let entity = all_storages.add_entity((USIZE(0), U32(1)));

let mut iter = all_storages.iter::<(&USIZE, &mut U32)>();

for (i, j) in &mut iter {
    // <-- SNIP -->
}

pub fn on_deletion(&self, f: impl FnMut(EntityId) + Send + Sync + 'static)

Sets the on entity deletion callback.

Borrows

• Entities (exclusive)

Panics

• Entities borrow failed.

Trait Implementations

impl AsRef<AllStorages> for AllStoragesView<'_>

fn as_ref(&self) -> &AllStorages

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> BorrowInfo for AllStoragesView<'a>

fn borrow_info(info: &mut Vec<TypeInfo>)

This information is used during workload creation to determine which systems can run in parallel.

fn enable_tracking(_: &mut Vec<fn(&AllStorages) -> Result<(), GetStorage>>)

Enable tracking on the World where this storage is borrowed.

impl Clone for AllStoragesView<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for AllStoragesView<'_>

type Target = AllStorages

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl WorldBorrow for AllStoragesView<'_>

type WorldView<'a> = AllStoragesView<'a>

fn world_borrow( world: &World, _last_run: Option<TrackingTimestamp>, _current: TrackingTimestamp, ) -> Result<Self::WorldView<'_>, GetStorage>

This function is where the actual borrowing happens.