Struct legion::world::Entity

source · [−]

#[repr(transparent)]
pub struct Entity(_);

Expand description

An opaque identifier for an entity.

Trait Implementations

source

impl Clone for Entity

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

type Filter = EntityFilterTuple<Any, Passthrough>

The filter constructed.

source

impl<'de> Deserialize<'de> for Entity

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Hash for Entity

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<Entity> for Entity

source

fn eq(&self, other: &Entity) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Entity) -> bool

This method tests for !=.

source

impl Serialize for Entity

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl<'data> View<'data> for Entity

type Element = <Self::Fetch as IntoIndexableIter>::Item

The type of component references returned.

type Fetch = EntityFetch<'data>

The fetch type yielded for each archetype.

type Iter = Iter<'data>

The iterator type which pulls entity data out of a world.

type Read = [ComponentTypeId ; 0]

Contains the type IDs read by the view.

type Write = [ComponentTypeId ; 0]

Contains the type IDs written by the view.

source

fn validate()

Determines if this view type is valid. Panics if checks fail.

source

fn validate_access(_: &ComponentAccess<'_>) -> bool

Returns true if the given component access includes all permissions required by the view.

source

fn reads_types() -> Self::Read

Returns the component types read by the view.

source

fn writes_types() -> Self::Write

Returns the component types written to by the view.

source

fn reads<D: Component>() -> bool

Returns true if the view reads the specified data type.

source

fn writes<D: Component>() -> bool

Returns true if the view writes to the specified data type.

source

fn requires_permissions() -> Permissions<ComponentTypeId>

Returns a permissions struct declaring the component accesses required by the view.

source

unsafe fn fetch(
 _: &'data Components,
 archetypes: &'data [Archetype ],
 query: QueryResult<'data>
) -> Self::Iter

Creates an iterator which will yield slices of entity data for each archetype. Read more

source

impl StructuralPartialEq for Entity

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 T where
T: 'static + ?Sized,

source

pub 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

pub 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

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

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for T where
T: Any,

source

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for T where
T: Any + Send + Sync,

source

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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> Serialize for T where
T: Serialize + ?Sized,

source

pub fn erased_serialize(
&self,
serializer: &mut dyn Serializer
) -> Result<Ok, Error>

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

pub 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

pub 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

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

Performs the conversion.

source

Struct legion::world::Entity

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

type Filter = EntityFilterTuple<Any, Passthrough>

impl<'de> Deserialize<'de> for Entity

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,

impl Hash for Entity

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<Entity> for Entity

fn eq(&self, other: &Entity) -> bool

fn ne(&self, other: &Entity) -> bool

impl Serialize for Entity

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,

impl<'data> View<'data> for Entity

type Element = <Self::Fetch as IntoIndexableIter>::Item

type Fetch = EntityFetch<'data>

type Iter = Iter<'data>

type Read = [ComponentTypeId; 0]

type Write = [ComponentTypeId; 0]

fn validate()

fn validate_access(_: &ComponentAccess<'_>) -> bool

fn reads_types() -> Self::Read

fn writes_types() -> Self::Write

fn reads<D: Component>() -> bool

fn writes<D: Component>() -> bool

fn requires_permissions() -> Permissions<ComponentTypeId>

unsafe fn fetch( _: &'data Components, archetypes: &'data [Archetype], query: QueryResult<'data>) -> Self::Iter

impl Copy for Entity

impl Eq for Entity

impl StructuralEq for Entity

impl StructuralPartialEq for Entity

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 T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Serialize for T where T: Serialize + ?Sized,

pub fn erased_serialize( &self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

pub 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

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

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

type Read = [ComponentTypeId ; 0]

type Write = [ComponentTypeId ; 0]

unsafe fn fetch(
_: &'data Components,
archetypes: &'data [Archetype ],
query: QueryResult<'data>
) -> Self::Iter

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> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

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

impl<T> Serialize for T where
T: Serialize + ?Sized,

pub fn erased_serialize(
&self,
serializer: &mut dyn Serializer
) -> Result<Ok, Error>

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>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,