Struct StorageWorld 

pub struct StorageWorld { /* private fields */ }

World that reads/writes individual entities from Soroban persistent storage.

Only dirty state is written back on flush(). Entities must be explicitly loaded before they can be queried or modified.

Implementations

impl StorageWorld

pub fn load_metadata(env: &Env) -> Self

Load world metadata from persistent storage.

If no metadata exists, creates a fresh world.

pub fn load_entity( &mut self, env: &Env, entity_id: EntityId, ) -> Result<(), CougrError>

Load a single entity’s component list and component data from storage.

pub fn load_entities( &mut self, env: &Env, entity_ids: &[EntityId], ) -> Result<(), CougrError>

Load multiple entities from storage.

pub fn spawn_entity(&mut self, env: &Env) -> EntityId

Spawn a new entity (assigns ID but doesn’t write to storage until flush).

pub fn add_component( &mut self, env: &Env, entity_id: EntityId, component_type: Symbol, data: Bytes, )

Add a component to an entity.

pub fn get_component( &self, entity_id: EntityId, component_type: &Symbol, ) -> Option<Bytes>

Get a component’s data from loaded state.

pub fn has_component( &self, entity_id: EntityId, component_type: &Symbol, ) -> bool

Check if a loaded entity has a component.

pub fn remove_component( &mut self, entity_id: EntityId, component_type: &Symbol, ) -> bool

Remove a component from an entity.

pub fn despawn_entity(&mut self, entity_id: EntityId)

Despawn an entity, removing all its components.

pub fn flush(&mut self, env: &Env)

Flush all dirty state to Soroban persistent storage.

Only writes entries that have been modified since the last flush.

pub fn version(&self) -> u64

Returns the current version counter.

pub fn next_entity_id(&self) -> EntityId

Returns the next entity ID.

pub fn entity_count(&self) -> u32

Returns the number of live entities.

pub fn entity_ids(&self) -> &Vec<EntityId>

Returns all known entity IDs from metadata.

pub fn to_simple_world(&self, env: &Env) -> SimpleWorld

Convert loaded state to a SimpleWorld.

Useful for running systems that expect SimpleWorld.

pub fn from_simple_world(world: &SimpleWorld, env: &Env) -> Self

Create a StorageWorld from a SimpleWorld (for migration).

Marks everything as dirty so the next flush() writes all state.