Struct scoundrel::EntityId

source · [−]

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

Expand description

Handle to an entity.

Implementations

source

impl EntityId

source

pub fn index(self) -> u64

Returns the index part of the EntityId.
⚠️ You shouldn’t use it to index a storage.

source

pub fn uindex(self) -> usize

Returns the index part of the EntityId as an usize.
⚠️ You shouldn’t use it to index a storage.

source

pub fn gen(self) -> u64

Returns the generation part of the EntityId.

source

pub fn dead() -> EntityId

Returns a dead EntityId, it can be used as a null entity.

source

pub fn inner(self) -> u64

Returns EntityId’s inner representation.

source

pub fn from_inner(inner: u64) -> Option<EntityId>

Build an EntityId from its inner representation.

Trait Implementations

source

impl Clone for EntityId

source

fn clone(&self) -> EntityId

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 EntityId

source

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

Formats the value using the given formatter. Read more

source

impl Hash for EntityId

source

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

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<T> Index<EntityId> for SparseSet<T>

type Output = T

The returned type after indexing.

source

fn index(&self, entity: EntityId) -> &<SparseSet<T> as Index<EntityId>>::Output

Performs the indexing (container[index]) operation. Read more

source

impl<T> IndexMut<EntityId> for SparseSet<T>

source

fn index_mut(
&mut self,
entity: EntityId
) -> &mut <SparseSet<T> as Index<EntityId>>::Output

Performs the mutable indexing (container[index]) operation. Read more

source

impl Ord for EntityId

source

fn cmp(&self, other: &EntityId) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl PartialEq<EntityId> for EntityId

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl PartialOrd<EntityId> for EntityId

source

fn partial_cmp(&self, other: &EntityId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl Copy for EntityId

source

impl Eq for EntityId

source

impl StructuralEq for EntityId

Auto Trait Implementations

impl RefUnwindSafe for EntityId

impl Send for EntityId

impl Sync for EntityId

impl Unpin for EntityId

impl UnwindSafe for EntityId

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

impl<T> CallHasher for T where
T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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.

source

impl<N> NodeTrait for N where
N: Copy + Ord + Hash,

source

Struct scoundrel::EntityId

Implementations

impl EntityId

pub fn index(self) -> u64

pub fn uindex(self) -> usize

pub fn gen(self) -> u64

pub fn dead() -> EntityId

pub fn inner(self) -> u64

pub fn from_inner(inner: u64) -> Option<EntityId>

Trait Implementations

impl Clone for EntityId

fn clone(&self) -> EntityId

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

impl Debug for EntityId

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

impl Hash for EntityId

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

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

impl<T> Index<EntityId> for SparseSet<T>

type Output = T

fn index(&self, entity: EntityId) -> &<SparseSet<T> as Index<EntityId>>::Output

impl<T> IndexMut<EntityId> for SparseSet<T>

fn index_mut( &mut self, entity: EntityId) -> &mut <SparseSet<T> as Index<EntityId>>::Output

impl Ord for EntityId

fn cmp(&self, other: &EntityId) -> Ordering

fn max(self, other: Self) -> Self

fn min(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl PartialEq<EntityId> for EntityId

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

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

impl PartialOrd<EntityId> for EntityId

fn partial_cmp(&self, other: &EntityId) -> Option<Ordering>

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

fn gt(&self, other: &Rhs) -> bool

fn ge(&self, other: &Rhs) -> bool

impl Copy for EntityId

impl Eq for EntityId

impl StructuralEq for EntityId

Auto Trait Implementations

impl RefUnwindSafe for EntityId

impl Send for EntityId

impl Sync for EntityId

impl Unpin for EntityId

impl UnwindSafe for EntityId

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> CallHasher for T where T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where H: Hasher,

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

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

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

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

fn index_mut(
&mut self,
entity: EntityId
) -> &mut <SparseSet<T> as Index<EntityId>>::Output

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> CallHasher for T where
T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?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>,

impl<N> NodeTrait for N where
N: Copy + Ord + Hash,

impl<T> Scalar for T where
T: 'static + Clone + PartialEq<T> + Debug,