Struct bevy_ecs::storage::Column

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

A type-erased contiguous container for data of a homogeneous type.

Conceptually, a Column is very similar to a type-erased Vec<T>. It also stores the change detection ticks for its components, kept in two separate contiguous buffers internally. An element shares its data across these buffers by using the same index (i.e. the entity at row 3 has its data at index 3 and its change detection ticks at index 3). A slice to these contiguous blocks of memory can be fetched via Column::get_data_slice, Column::get_added_ticks_slice, and Column::get_changed_ticks_slice.

Like many other low-level storage types, Column has a limited and highly unsafe interface. It’s highly advised to use higher level types and their safe abstractions instead of working directly with Column.

Implementations§

source§

impl Column

source

pub fn item_layout(&self) -> Layout

Fetches the Layout for the underlying type.

source

pub fn len(&self) -> usize

Gets the current number of elements stored in the column.

source

pub fn is_empty(&self) -> bool

Checks if the column is empty. Returns true if there are no elements, false otherwise.

source

pub fn get_data_ptr(&self) -> Ptr<'_>

Fetches the data pointer to the first element of the Column.

The pointer is type erased, so using this function to fetch anything other than the first element will require computing the offset using Column::item_layout.

source

pub unsafe fn get_data_slice<T>(&self) -> &[UnsafeCell<T>]

Fetches the slice to the Column’s data cast to a given type.

Note: The values stored within are UnsafeCell. Users of this API must ensure that accesses to each individual element adhere to the safety invariants of UnsafeCell.

§Safety

The type T must be the type of the items in this column.

source

pub fn get_added_ticks_slice(&self) -> &[UnsafeCell<Tick>]

Fetches the slice to the Column’s “added” change detection ticks.

Note: The values stored within are UnsafeCell. Users of this API must ensure that accesses to each individual element adhere to the safety invariants of UnsafeCell.

source

pub fn get_changed_ticks_slice(&self) -> &[UnsafeCell<Tick>]

Fetches the slice to the Column’s “changed” change detection ticks.

Note: The values stored within are UnsafeCell. Users of this API must ensure that accesses to each individual element adhere to the safety invariants of UnsafeCell.

source

pub fn get(&self, row: TableRow) -> Option<(Ptr<'_>, TickCells<'_>)>

Fetches a reference to the data and change detection ticks at row.

Returns None if row is out of bounds.

source

pub fn get_data(&self, row: TableRow) -> Option<Ptr<'_>>

Fetches a read-only reference to the data at row.

Returns None if row is out of bounds.

source

pub unsafe fn get_data_unchecked(&self, row: TableRow) -> Ptr<'_>

Fetches a read-only reference to the data at row. Unlike Column::get this does not do any bounds checking.

§Safety
  • row must be within the range [0, self.len()).
  • no other mutable reference to the data of the same row can exist at the same time
source

pub fn get_data_mut(&mut self, row: TableRow) -> Option<PtrMut<'_>>

Fetches a mutable reference to the data at row.

Returns None if row is out of bounds.

source

pub fn get_added_tick(&self, row: TableRow) -> Option<&UnsafeCell<Tick>>

Fetches the “added” change detection tick for the value at row.

Returns None if row is out of bounds.

Note: The values stored within are UnsafeCell. Users of this API must ensure that accesses to each individual element adhere to the safety invariants of UnsafeCell.

source

pub fn get_changed_tick(&self, row: TableRow) -> Option<&UnsafeCell<Tick>>

Fetches the “changed” change detection tick for the value at row.

Returns None if row is out of bounds.

Note: The values stored within are UnsafeCell. Users of this API must ensure that accesses to each individual element adhere to the safety invariants of UnsafeCell.

source

pub fn get_ticks(&self, row: TableRow) -> Option<ComponentTicks>

Fetches the change detection ticks for the value at row.

Returns None if row is out of bounds.

source

pub unsafe fn get_added_tick_unchecked( &self, row: TableRow ) -> &UnsafeCell<Tick>

Fetches the “added” change detection tick for the value at row. Unlike Column::get_added_tick this function does not do any bounds checking.

§Safety

row must be within the range [0, self.len()).

source

pub unsafe fn get_changed_tick_unchecked( &self, row: TableRow ) -> &UnsafeCell<Tick>

Fetches the “changed” change detection tick for the value at row. Unlike Column::get_changed_tick this function does not do any bounds checking.

§Safety

row must be within the range [0, self.len()).

source

pub unsafe fn get_ticks_unchecked(&self, row: TableRow) -> ComponentTicks

Fetches the change detection ticks for the value at row. Unlike Column::get_ticks this function does not do any bounds checking.

§Safety

row must be within the range [0, self.len()).

source

pub fn clear(&mut self)

Clears the column, removing all values.

Note that this function has no effect on the allocated capacity of the Column>

Trait Implementations§

source§

impl Debug for Column

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Column

§

impl !RefUnwindSafe for Column

§

impl !Send for Column

§

impl !Sync for Column

§

impl Unpin for Column

§

impl UnwindSafe for Column

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