Skip to main content

EntityTable

Struct EntityTable 

Source
pub struct EntityTable { /* private fields */ }
Expand description

Indirection table mapping EntityId to metadata about stored data.

Implementations§

Source§

impl EntityTable

Source

pub fn new() -> Self

Create an empty entity table.

Source

pub fn allocate( &mut self, offset: u32, len: u32, save_level: u16, global: bool, created_after_save: u32, ) -> EntityId

Allocate a new entity, returning its EntityId. The returned EntityId is tagged with the global bit based on the global param.

Source

pub fn get(&self, id: EntityId) -> &EntityMeta

Get metadata for an entity (read-only).

Source

pub fn get_mut(&mut self, id: EntityId) -> &mut EntityMeta

Get mutable metadata for an entity.

Source

pub fn get_by_index(&self, index: usize) -> &EntityMeta

Get metadata by raw table index, without needing a tagged EntityId.

Callers that sweep the whole table (the VM audit) do not have an EntityId in hand — they need the metadata in order to build one with the correct global tag.

Source

pub fn len(&self) -> usize

Number of entities allocated.

Source

pub fn truncate(&mut self, n: usize)

Drop every entity from index n onward, so their ids become available for reuse.

Only sound when no reachable object still refers to those ids. restore establishes that: PLRM 3.7.3.2 forbids a surviving reference to a composite created after the save (enforced by check_invalidrestore), and COW reverts any pre-save composite that was mutated to point at one.

Note that this makes EntityIds reusable. Anything keyed by EntityId that outlives a restore must be purged in the same step, or a later entity reusing the index will collide with the stale entry.

Source

pub fn is_empty(&self) -> bool

Whether the table is empty.

Trait Implementations§

Source§

impl Default for EntityTable

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

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

Source§

type Error = !

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>,

Source§

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.