Struct Table

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

A wrapper class that gives direct access to the component arrays of a table, the table data

Implementations

impl<'a> Table<'a>

pub fn new(world: impl WorldProvider<'a>, table: NonNull<ecs_table_t>) -> Self

Creates a wrapper around a table

Arguments

• world - The world the table is in
• table - The table to wrap

See also

• C++ API: table::table

Trait Implementations

impl<'a> Clone for Table<'a>

fn clone(&self) -> Table<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Table<'a>

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

Formats the value using the given formatter.

impl IntoTable for Table<'_>

fn table_ptr_mut(&self) -> *mut ecs_table_t

impl IntoTableRange for Table<'_>

fn range(&self) -> TableRange<'_>

fn range_raw(&self) -> ecs_table_range_t

impl<'a> TableOperations<'a> for Table<'a>

fn count(&self) -> i32

Returns the table count

See also

• C++ API: table::count

fn table(&self) -> Table<'a>

fn offset(&self) -> i32

fn world(&self) -> WorldRef<'a>

fn to_string(&self) -> Option<String>

Converts table type to string

fn archetype(&self) -> Archetype<'a>

Returns the type of the table

fn find_type_index_id(&self, id: ecs_id_t) -> Option<i32>

Find type index for (component) id

fn find_type_index<T: ComponentId>(&self) -> Option<i32>

Find type index for component type

fn find_type_index_pair_ids( &self, first: impl Into<Entity>, second: impl Into<Entity>, ) -> Option<i32>

Find type index for pair of component types

fn find_type_index_pair<First: ComponentId, Second: ComponentId>( &self, ) -> Option<i32>

Find type index for pair of component types

fn find_type_index_second_id<First: ComponentId>( &self, second: impl Into<Entity>, ) -> Option<i32>

Find type index for pair of component types

fn find_column_index_id(&self, id: ecs_id_t) -> Option<i32>

Find index for (component) id in table type

fn find_column_index<T: ComponentId>(&self) -> Option<i32>

Find column index for component type in table

fn find_column_index_pair<First: ComponentId, Second: ComponentId>( &self, ) -> Option<i32>

Find index for pair of component types in table

fn find_column_index_pair_ids( &self, first: impl Into<Entity>, second: impl Into<Entity>, ) -> Option<i32>

Find index for pair of component ids in table type

fn find_column_index_second_id<First: ComponentId>( &self, second: impl Into<Entity>, ) -> Option<i32>

Find index for pair of component types in table type

fn has_type<T: ComponentId>(&self) -> bool

Test if table has component type

fn has_type_id(&self, id: ecs_id_t) -> bool

Test if table has (component) id

fn has_pair<First: ComponentId, Second: ComponentId>(&self) -> bool

Test if table has pair of component types

fn has_pair_ids( &self, first: impl Into<Entity>, second: impl Into<Entity>, ) -> bool

Test if table has pair of component ids

fn column_untyped(&self, index: i32) -> Option<*mut c_void>

Get column, components array ptr from table by column index.

fn get_mut<T: ComponentId>(&self) -> Option<&mut [T]>

Get column, components array ptr from table by component type.

fn get_mut_untyped(&self, id: ecs_id_t) -> Option<*mut c_void>

Get column, components array ptr from table by component type.

fn get_pair_ids_mut_untyped( &self, first: impl Into<Entity>, second: impl Into<Entity>, ) -> Option<*mut c_void>

Get column, components array ptr from table by pair ids.

fn get_pair_mut_untyped<First: ComponentId, Second: ComponentId>( &self, ) -> Option<*mut c_void>

Get column, components array ptr from table by pair of component types.

fn column_size(&self, index: i32) -> usize

Get column size from table at the provided column index.

fn depth<Rel: ComponentId>(&self) -> i32

Return depth for table in tree for relationship type. Depth is determined by counting the number of targets encountered while traversing up the relationship tree for rel. Only acyclic relationships are supported.

fn depth_id(&self, rel: impl Into<Entity>) -> i32

Return depth for table in tree for relationship type. Depth is determined by counting the number of targets encountered while traversing up the relationship tree for rel. Only acyclic relationships are supported.

impl<'a> Copy for Table<'a>