Struct bevy_ecs::storage::Table

source ·
pub struct Table { /* private fields */ }
Expand description

A column-oriented structure-of-arrays based storage for Components of entities in a World.

Conceptually, a Table can be thought of as an HashMap<ComponentId, Column>, where each Column is a type-erased Vec<T: Component>. Each row corresponds to a single entity (i.e. index 3 in Column A and index 3 in Column B point to different components on the same entity). Fetching components from a table involves fetching the associated column for a component type (via its ComponentId), then fetching the entity’s row within that column.

Implementations§

source§

impl Table

source

pub fn entities(&self) -> &[Entity]

Fetches a read-only slice of the entities stored within the Table.

source

pub fn get_column(&self, component_id: ComponentId) -> Option<&Column>

Fetches a read-only reference to the Column for a given Component within the table.

Returns None if the corresponding component does not belong to the table.

source

pub fn has_column(&self, component_id: ComponentId) -> bool

Checks if the table contains a Column for a given Component.

Returns true if the column is present, false otherwise.

source

pub fn entity_count(&self) -> usize

Gets the number of entities currently being stored in the table.

source

pub fn component_count(&self) -> usize

Gets the number of components being stored in the table.

source

pub fn entity_capacity(&self) -> usize

Gets the maximum number of entities the table can currently store without reallocating the underlying memory.

source

pub fn is_empty(&self) -> bool

Checks if the Table is empty or not.

Returns true if the table contains no entities, false otherwise.

source

pub fn iter(&self) -> impl Iterator<Item = &Column>

Iterates over the Columns of the Table.

Auto Trait Implementations§

§

impl Freeze for Table

§

impl !RefUnwindSafe for Table

§

impl !Send for Table

§

impl !Sync for Table

§

impl Unpin for Table

§

impl UnwindSafe for Table

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> 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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

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.

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more