Struct Station 

pub struct Station { /* private fields */ }

Station-local storage and metadata.

Implementations

impl Station

pub fn new(config: StationConfig) -> Self

Creates an empty station.

pub fn with_capacity(config: StationConfig, entity_capacity: usize) -> Self

Creates an empty station with capacity for local entity records.

pub fn reserve_entities(&mut self, additional: usize)

Reserves capacity for at least additional more local entities.

pub fn reserve_free_handles(&mut self, additional: usize)

Reserves recycled-handle slots for caller-expected despawn churn.

pub fn reclaim_retained_capacity(&mut self)

Releases unused retained storage without changing live handles.

pub fn entity_capacity(&self) -> usize

Entity record slots currently retained without another allocation.

pub fn id_index_capacity(&self) -> usize

Entity-id lookup entries currently retained without another rehash.

pub fn free_list_capacity(&self) -> usize

Recycled handle indexes currently retained without another allocation.

pub const fn config(&self) -> StationConfig

Returns station configuration.

pub const fn tick(&self) -> Tick

Current station tick.

pub const fn owner_epoch(&self) -> OwnerEpoch

Current owner epoch.

pub fn next_owner_epoch(&mut self) -> OwnerEpoch

Reserves and returns the next owner epoch for this station.

pub fn len(&self) -> usize

Number of live entity records.

pub fn is_empty(&self) -> bool

Returns whether the station has no entity records.

pub fn advance_tick(&mut self)

Advances the authoritative station tick.

pub fn spawn_owned( &mut self, id: EntityId, position: Position3, bounds: Bounds, policy_id: PolicyId, ) -> Result<EntityHandle, StationError>

Spawns an authoritative entity in this station.

pub fn upsert_ghost( &mut self, id: EntityId, position: Position3, bounds: Bounds, policy_id: PolicyId, owner_station: StationId, owner_epoch: OwnerEpoch, expires_at: Tick, ) -> EntityHandle

Inserts or refreshes a read-only ghost entity.

pub fn get(&self, handle: EntityHandle) -> Option<&EntityRecord>

Gets an entity by handle if the generation is still valid.

pub fn get_mut(&mut self, handle: EntityHandle) -> Option<&mut EntityRecord>

Gets a mutable entity record by handle.

pub fn get_by_id(&self, id: EntityId) -> Option<&EntityRecord>

Gets an entity by stable id.

pub fn get_by_id_mut(&mut self, id: EntityId) -> Option<&mut EntityRecord>

Gets a mutable entity record by stable id.

pub fn handle_by_id(&self, id: EntityId) -> Option<EntityHandle>

Gets a station-local handle by stable id.

pub fn move_owned( &mut self, handle: EntityHandle, position: Position3, ) -> Result<(), StationError>

Moves an authoritative entity and marks transform dirty.

pub fn set_tags( &mut self, handle: EntityHandle, tags: EntityTags, ) -> Result<(), StationError>

Replaces authoritative entity tags and marks tags dirty.

pub fn clear_dirty( &mut self, handle: EntityHandle, mask: DirtyMask, ) -> Result<(), StationError>

Clears selected dirty bits for a local entity record.

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

Iterates over live records.

pub fn remove( &mut self, handle: EntityHandle, ) -> Result<EntityRecord, StationError>

Removes an entity record by handle.

pub fn remove_by_id( &mut self, id: EntityId, ) -> Result<EntityRecord, StationError>

Removes an entity record by stable id.

pub fn prepare_outgoing_handoff( &self, entity_id: EntityId, target_station: StationId, target_owner_epoch: OwnerEpoch, source_ghost_expires_at: Tick, ) -> Result<HandoffTransfer, StationError>

Prepares an outgoing handoff transfer without mutating ownership yet.

pub fn prewarm_handoff_ghost( &mut self, transfer: &HandoffTransfer, ) -> Result<EntityHandle, StationError>

Prewarms or refreshes a target-side ghost before owner commit.

pub fn commit_incoming_handoff( &mut self, transfer: HandoffTransfer, ) -> Result<EntityHandle, StationError>

Commits the target side of an incoming handoff and becomes authoritative.

pub fn commit_outgoing_handoff( &mut self, transfer: &HandoffTransfer, ) -> Result<EntityHandle, StationError>

Commits the source side of an outgoing handoff and keeps a short-lived ghost.

pub fn snapshot(&self, version: SnapshotVersion) -> StationSnapshot

Exports an in-memory station snapshot.

pub fn snapshot_into( &self, version: SnapshotVersion, snapshot: &mut StationSnapshot, )

Exports an in-memory snapshot into caller-owned reusable storage.

pub fn restore( config: StationConfig, snapshot: StationSnapshot, ) -> Result<Self, StationError>

Restores station state from a snapshot.

pub fn restore_tracked( config: StationConfig, snapshot: StationSnapshot, ) -> Result<(Self, StationRestoreStats), StationError>

Restores station state and reports capacity behavior during insertion.

Trait Implementations

impl Clone for Station

fn clone(&self) -> Station

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Station

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

Formats the value using the given formatter.