Struct bevy_ecs::storage::TableId

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

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

impl TableId

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.

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.

pub const fn as_u32(self) -> u32

Gets the underlying table index from the ID.

pub const fn as_usize(self) -> usize

Gets the underlying table index from the ID.

pub const fn empty() -> Self

The TableId of the Table without any components.

Trait Implementations

impl Clone for TableId

fn clone(&self) -> TableId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableId

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

Formats the value using the given formatter.

impl Index<TableId> for Tables

type Output = Table

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<TableId> for Tables

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

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

impl PartialEq for TableId

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

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

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

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

impl Copy for TableId

impl Eq for TableId

impl StructuralEq for TableId

impl StructuralPartialEq for TableId