Skip to main content

ComponentStore

Struct ComponentStore 

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

Station-local sparse component blob store.

Implementations§

Source§

impl ComponentStore

Source

pub fn reserve_component( &mut self, component_id: ComponentId, additional_entities: usize, )

Reserves sparse blob entries for one component column.

Source

pub fn reclaim_retained_capacity(&mut self)

Releases unused retained column and entity-map storage.

Source

pub fn column_slots_capacity(&self) -> usize

Component column slots currently retained without another allocation.

Source

pub fn component_capacity(&self, component_id: ComponentId) -> usize

Sparse entity entries retained for one component without another rehash.

Source

pub fn set_blob( &mut self, descriptor: &ComponentDescriptor, entity: EntityHandle, version: u64, bytes: Vec<u8>, ) -> Result<(), ComponentStoreError>

Writes an opaque component blob.

Source

pub fn set_blob_from_slice( &mut self, descriptor: &ComponentDescriptor, entity: EntityHandle, version: u64, bytes: &[u8], ) -> Result<(), ComponentStoreError>

Copies an opaque component value into retained blob storage.

Existing blob byte capacity is reused when sufficient. Validation runs before mutation, so failed writes leave the previous value unchanged.

Source

pub fn set_typed<T, C: ComponentCodec<T>>( &mut self, descriptor: &ComponentDescriptor, entity: EntityHandle, version: u64, codec: &C, value: &T, ) -> Result<(), ComponentStoreError>

Encodes and writes a typed component value using codec.

Source

pub fn set_typed_with_scratch<T, C: ComponentCodec<T>>( &mut self, descriptor: &ComponentDescriptor, entity: EntityHandle, version: u64, codec: &C, value: &T, scratch: &mut ComponentEncodeScratch, ) -> Result<(), ComponentStoreError>

Encodes a typed value through caller-owned scratch and copies it into retained blob storage.

Source

pub fn get_blob( &self, component_id: ComponentId, entity: EntityHandle, ) -> Option<&ComponentBlob>

Gets an opaque component blob.

Source

pub fn has_dirty_selected( &self, entity: EntityHandle, component_ids: &[ComponentId], ) -> bool

Returns whether any selected component on entity is dirty.

This is a low-level convenience for caller-owned replication eligibility rules; the store does not clear dirty state or track per-client delivery.

Source

pub fn get_typed<T, C: ComponentCodec<T>>( &self, component_id: ComponentId, entity: EntityHandle, codec: &C, ) -> Result<T, ComponentStoreError>

Decodes a typed component value using codec.

Source

pub fn get_blob_mut( &mut self, component_id: ComponentId, entity: EntityHandle, ) -> Option<&mut ComponentBlob>

Gets a mutable opaque component blob.

Source

pub fn clear_dirty_for_entity(&mut self, entity: EntityHandle) -> usize

Clears dirty flags for all components on one entity.

Source

pub fn remove_entity( &mut self, entity: EntityHandle, ) -> Vec<(ComponentId, ComponentBlob)>

Removes all component blobs for an entity and returns the removed values.

Source

pub fn remove_entity_into( &mut self, entity: EntityHandle, removed: &mut Vec<(ComponentId, ComponentBlob)>, ) -> usize

Removes all component blobs into caller-owned reusable output storage.

Source

pub fn clear_entity(&mut self, entity: EntityHandle) -> usize

Removes and drops all component blobs for an entity without output storage.

Source

pub fn copy_for_migration( &mut self, registry: &ComponentRegistry, source: EntityHandle, target: EntityHandle, ) -> usize

Copies migratable component blobs from one entity handle to another.

Source

pub fn blob_count(&self) -> usize

Returns number of component blobs stored in all columns.

Source

pub fn column_count(&self) -> usize

Number of component columns currently registered in the store.

Trait Implementations§

Source§

impl Clone for ComponentStore

Source§

fn clone(&self) -> ComponentStore

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ComponentStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ComponentStore

Source§

fn default() -> ComponentStore

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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

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.