Struct apecs::Entity

source · [−]

pub struct Entity { /* private fields */ }

Expand description

Associates a discrete group of components within the world.

Entity can be used to add and remove components lazily.

Implementations

source

impl Entity

source

pub fn id(&self) -> usize

source

pub fn with_bundle<B: IsBundle + Send + Sync + 'static>(self, bundle: B) -> Self

Lazily add a component bundle to archetype storage.

This entity will have the associated components after the next tick.

source

pub fn insert_bundle<B: IsBundle + Send + Sync + 'static>(&mut self, bundle: B)

Lazily add a component bundle to archetype storage.

This entity will have the associated components after the next tick.

source

pub fn insert_component<T: Send + Sync + 'static>(&mut self, component: T)

Lazily add a component bundle to archetype storage.

This entity will have the associated component after the next tick.

source

pub fn remove_component<T: Send + Sync + 'static>(&mut self)

Lazily remove a component bundle to archetype storage.

This entity will have lost the associated component after the next tick.

source

pub async fn updates(&mut self)

Await a future that completes after all lazy updates have been performed.

source

pub async fn visit<Q: IsQuery + 'static, T: Send + Sync + 'static>(
&self,
f: impl FnOnce(Q::QueryRow<'_>) -> T + Send + Sync + 'static
) -> Option<T>

Visit this entity’s query row in storage, if it exists.

Panics

Panics if the query is malformed (the bundle is not unique).

Methods from Deref<Target = usize>

1.43.0 · source

pub const MIN: usize = 0usize

1.43.0 · source

pub const MAX: usize = 4_294_967_295usize

1.53.0 · source

pub const BITS: u32 = 32u32

Trait Implementations

source

impl Clone for Entity

You may clone entities, but each one does its own lazy updates, separate from all other clones.

source

fn clone(&self) -> Self

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 Debug for Entity

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl Deref for Entity

type Target = usize

The resulting type after dereferencing.

source

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

Dereferences the value.

Auto Trait Implementations

impl !RefUnwindSafe for Entity

impl Send for Entity

impl Sync for Entity

impl Unpin for Entity

impl !UnwindSafe for Entity

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
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 Twhere
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::<T>()

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> ToOwned for Twhere
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)

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

source

impl<T, U> TryFrom for Twhere
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 Twhere
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.

source

impl<T> IsResource for Twhere
T: 'static + Any + Send + Sync,

source

impl<T> SatisfyTraits<dyn Cloneable + 'static> for Twhere
T: Clone,

source

impl<T> SatisfyTraits<dyn Cloneable + Send + 'static> for Twhere
T: Clone + Send,

source

impl<T> SatisfyTraits<dyn Cloneable + Send + Sync + 'static> for Twhere
T: Clone + Send + Sync,

source

impl<T> SatisfyTraits<dyn Cloneable + Sync + 'static> for Twhere
T: Clone + Sync,

source

Struct apecs::Entity

Implementations

impl Entity

pub fn id(&self) -> usize

pub fn with_bundle<B: IsBundle + Send + Sync + 'static>(self, bundle: B) -> Self

pub fn insert_bundle<B: IsBundle + Send + Sync + 'static>(&mut self, bundle: B)

pub fn insert_component<T: Send + Sync + 'static>(&mut self, component: T)

pub fn remove_component<T: Send + Sync + 'static>(&mut self)

pub async fn updates(&mut self)

pub async fn visit<Q: IsQuery + 'static, T: Send + Sync + 'static>( &self, f: impl FnOnce(Q::QueryRow<'_>) -> T + Send + Sync + 'static) -> Option<T>

Panics

Methods from Deref<Target = usize>

pub const MIN: usize = 0usize

pub const MAX: usize = 4_294_967_295usize

pub const BITS: u32 = 32u32

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Self

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

impl Debug for Entity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Deref for Entity

type Target = usize

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

Auto Trait Implementations

impl !RefUnwindSafe for Entity

impl Send for Entity

impl Sync for Entity

impl Unpin for Entity

impl !UnwindSafe for Entity

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere 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 Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

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> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> IsResource for Twhere T: 'static + Any + Send + Sync,

impl<T> SatisfyTraits<dyn Cloneable + 'static> for Twhere T: Clone,

impl<T> SatisfyTraits<dyn Cloneable + Send + 'static> for Twhere T: Clone + Send,

impl<T> SatisfyTraits<dyn Cloneable + Send + Sync + 'static> for Twhere T: Clone + Send + Sync,

impl<T> SatisfyTraits<dyn Cloneable + Sync + 'static> for Twhere T: Clone + Sync,

impl<T> SatisfyTraits<dyn None + 'static> for T

impl<T> SatisfyTraits<dyn Send + 'static> for Twhere T: Send,

impl<T> SatisfyTraits<dyn Send + Sync + 'static> for Twhere T: Send + Sync,

impl<T> SatisfyTraits<dyn Sync + 'static> for Twhere T: Sync,

pub async fn visit<Q: IsQuery + 'static, T: Send + Sync + 'static>(
&self,
f: impl FnOnce(Q::QueryRow<'_>) -> T + Send + Sync + 'static
) -> Option<T>

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

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

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

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

impl<T> IsResource for Twhere
T: 'static + Any + Send + Sync,

impl<T> SatisfyTraits<dyn Cloneable + 'static> for Twhere
T: Clone,

impl<T> SatisfyTraits<dyn Cloneable + Send + 'static> for Twhere
T: Clone + Send,

impl<T> SatisfyTraits<dyn Cloneable + Send + Sync + 'static> for Twhere
T: Clone + Send + Sync,

impl<T> SatisfyTraits<dyn Cloneable + Sync + 'static> for Twhere
T: Clone + Sync,

impl<T> SatisfyTraits<dyn Send + 'static> for Twhere
T: Send,

impl<T> SatisfyTraits<dyn Send + Sync + 'static> for Twhere
T: Send + Sync,

impl<T> SatisfyTraits<dyn Sync + 'static> for Twhere
T: Sync,