Struct xecs::Entity

source · [−]

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

Expand description

A useful struct for building a entity

Implementations

source

impl<'a> Entity<'a>

source

pub fn into_id(self) -> EntityId

Consume Entity and get an ID

source

pub fn attach<T: Component>(self, component: T) -> Self

Attach a component to entity

Panics

Panics if T has not been registered

source

pub fn detach<T: Component>(&self) -> Option<T>

Detach a component from entity

Panics

Panics if T has not been registered

source

pub fn component_read<T: Component>(&self) -> Option<ComponentRead<'_, T>>

Read component of this entity

source

pub fn component_write<T: Component>(&self) -> Option<ComponentWrite<'_, T>>

Write component of this entity

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Entity<'a>

impl<'a> !Send for Entity<'a>

impl<'a> Sync for Entity<'a>

impl<'a> Unpin for Entity<'a>

impl<'a> !UnwindSafe for Entity<'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.

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 xecs::Entity

Implementations

impl<'a> Entity<'a>

pub fn into_id(self) -> EntityId

pub fn attach<T: Component>(self, component: T) -> Self

Panics

pub fn detach<T: Component>(&self) -> Option<T>

Panics

pub fn component_read<T: Component>(&self) -> Option<ComponentRead<'_, T>>

pub fn component_write<T: Component>(&self) -> Option<ComponentWrite<'_, T>>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Entity<'a>

impl<'a> !Send for Entity<'a>

impl<'a> Sync for Entity<'a>

impl<'a> Unpin for Entity<'a>

impl<'a> !UnwindSafe for Entity<'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, 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>

Struct xecs::Entity

Implementations

impl<'a> Entity<'a>

pub fn into_id(self) -> EntityId

pub fn attach<T: Component>(self, component: T) -> Self

Panics

pub fn detach<T: Component>(&self) -> Option<T>

Panics

pub fn component_read<T: Component>(&self) -> Option<ComponentRead<'_, T>>

pub fn component_write<T: Component>(&self) -> Option<ComponentWrite<'_, T>>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Entity<'a>

impl<'a> !Send for Entity<'a>

impl<'a> Sync for Entity<'a>

impl<'a> Unpin for Entity<'a>

impl<'a> !UnwindSafe for Entity<'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, 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>

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<T, U> TryFrom<U> for T where
U: Into<T>,

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