Struct TableId

Source

pub struct TableId(/* private fields */);

Expand description

An opaque unique ID for a Table within a World.

Can be used with Tables::get to fetch the corresponding table.

Each Archetype always points to a table via Archetype::table_id. Multiple archetypes can point to the same table so long as the components stored in the table are identical, but do not share the same sparse set components.

Implementations§

Source §

impl TableId

Source

pub const fn from_u32(index: u32) -> Self

Creates a new TableId.

index must be retrieved from calling TableId::as_u32 on a TableId you got from a table of a given World or the created ID may be invalid.

Source

pub const fn from_usize(index: usize) -> Self

Creates a new TableId.

index must be retrieved from calling TableId::as_usize on a TableId you got from a table of a given World or the created ID may be invalid.

§Panics

Will panic if the provided value does not fit within a u32.

Source

pub const fn as_u32(self) -> u32

Gets the underlying table index from the ID.

Source

pub const fn as_usize(self) -> usize

Gets the underlying table index from the ID.

Source

pub const fn empty() -> Self

The TableId of the Table without any components.

Trait Implementations§

Source §

impl Clone for TableId

Source §

fn clone(&self) -> TableId

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 TableId

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Index<TableId> for Tables

Source §

type Output = Table

The returned type after indexing.

Source §

fn index(&self, index: TableId) -> &Self::Output

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

Source §

impl IndexMut<TableId> for Tables

Source §

fn index_mut(&mut self, index: TableId) -> &mut Self::Output

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

Source §

impl PartialEq for TableId

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl Copy for TableId

Source §

impl Eq for TableId

Source §

impl StructuralPartialEq for TableId

Auto Trait Implementations§

§

impl UnwindSafe for TableId

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,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dst: *mut u8)

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

Performs copy-assignment from self to dst. Read more

Source §

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

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

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.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

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

Source §

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.

Source §

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.

Source §

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

Source §

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

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

Source §