Struct scoundrel::EntitiesView

source · [−]

pub struct EntitiesView<'a> { /* private fields */ }

Expand description

Shared view over Entities storage.

Methods from Deref<Target = Entities>

source

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

Returns true if entity matches a living entity.

source

pub fn add_component<S>(
 &self,
 entity: EntityId,
 storages: S,
 component: <S as AddComponent>::Component
) where
 S: AddComponent,

Adds component to entity, multiple components can be added at the same time using a tuple.
Entities is only borrowed immutably.

Panics

entity is not alive.

Example

use shipyard::{EntitiesView, ViewMut, World};

let mut world = World::new();

let entity = world.add_entity(());

let (entities, mut u32s) = world.borrow::<(EntitiesView, ViewMut<u32>)>().unwrap();

entities.add_component(entity, &mut u32s, 0);

source

pub fn iter(&self) -> EntitiesIter<'_>

Creates an iterator over all entities.

Trait Implementations

source

impl<'a> BorrowInfo for EntitiesView<'a>

source

fn borrow_info(infos: &mut Vec<TypeInfo, Global>)

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

source

impl<'_> Clone for EntitiesView<'_>

source

fn clone(&self) -> EntitiesView<'_>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'_> Deref for EntitiesView<'_>

type Target = Entities

The resulting type after dereferencing.

source

fn deref(&self) -> &<EntitiesView<'_> as Deref>::Target

Dereferences the value.

source

impl<'_> IntoBorrow for EntitiesView<'_>

type Borrow = EntitiesBorrower

Helper type almost allowing GAT on stable.

Auto Trait Implementations

impl<'a> RefUnwindSafe for EntitiesView<'a>

impl<'a> Send for EntitiesView<'a>

impl<'a> Sync for EntitiesView<'a>

impl<'a> Unpin for EntitiesView<'a>

impl<'a> UnwindSafe for EntitiesView<'a>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct scoundrel::EntitiesView

Methods from Deref<Target = Entities>

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

pub fn add_component<S>( &self, entity: EntityId, storages: S, component: <S as AddComponent>::Component) where S: AddComponent,

pub fn iter(&self) -> EntitiesIter<'_>

Trait Implementations

impl<'a> BorrowInfo for EntitiesView<'a>

fn borrow_info(infos: &mut Vec<TypeInfo, Global>)

impl<'_> Clone for EntitiesView<'_>

fn clone(&self) -> EntitiesView<'_>

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

impl<'_> Deref for EntitiesView<'_>

type Target = Entities

fn deref(&self) -> &<EntitiesView<'_> as Deref>::Target

impl<'_> IntoBorrow for EntitiesView<'_>

type Borrow = EntitiesBorrower

Auto Trait Implementations

impl<'a> RefUnwindSafe for EntitiesView<'a>

impl<'a> Send for EntitiesView<'a>

impl<'a> Sync for EntitiesView<'a>

impl<'a> Unpin for EntitiesView<'a>

impl<'a> UnwindSafe for EntitiesView<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn add_component<S>(
&self,
entity: EntityId,
storages: S,
component: <S as AddComponent>::Component
) where
S: AddComponent,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,