Struct ShardingHandle 

pub struct ShardingHandle { /* private fields */ }

Running sharding region handle.

Implementations

impl ShardingHandle

pub fn node_id(&self) -> &str

Local cluster node id for this region.

pub async fn register_entity_type<M, F, B>( &self, type_name: impl Into<String>, factory: F, ) -> ShardingResult<()>

where M: Serialize + DeserializeOwned + Send + 'static, F: Fn(EntityContext) -> B + Send + Sync + 'static, B: EntityBehavior<M>,

Register an entity type with a Ractor-backed factory.

pub async fn register_actor_entity_type<M, F, A>( &self, type_name: impl Into<String>, factory: F, ) -> ShardingResult<()>

where M: Serialize + DeserializeOwned + Send + 'static, F: Fn(EntityContext) -> A + Send + Sync + 'static, A: ActorEntity<M>,

Register an entity type whose factory creates a spawnable actor entity.

The factory mirrors Akka Cluster Sharding’s EntityContext<M> => Behavior<M> boundary: it is invoked once for each entity incarnation, and ActorEntity::spawn returns the typed mailbox ingress used for routing M. Passivation and handoff stop that actor. A self-stopped actor remains stopped until the next delivery, which creates a new incarnation without retrying the message that caused the stop.

pub async fn register_remembered_entity_type<M, F, B>( &self, type_name: impl Into<String>, factory: F, ) -> ShardingResult<()>

where M: Serialize + DeserializeOwned + Send + 'static, F: Fn(EntityContext) -> B + Send + Sync + 'static, B: EntityBehavior<M>,

Register an entity type with remember-entities enabled.

The region must be configured with RememberEntitiesConfig::with_store or registration fails. Remembered entities are spawned automatically when their shard starts locally after rebalance, restart recovery, or coordinator takeover. Passivation removes the id from the remember store; ordinary actor failure/restart and node stop do not.

pub fn subscribe_remember_entities_events( &self, ) -> Receiver<RememberEntitiesEvent>

Subscribe to remember-entities store failure events.

pub async fn flush_remember_entities(&self) -> ShardingResult<()>

Wait until previously queued remember-entities writes have been processed.

pub fn entity_ref<M>( &self, type_name: impl Into<String>, entity_id: impl Into<String>, ) -> EntityRef<M>

where M: Serialize + Send + 'static,

Return an entity ref using the configured default extractor.

pub fn entity_ref_with_extractor<M, E>( &self, type_name: impl Into<String>, entity_id: impl Into<String>, extractor: Arc<E>, ) -> EntityRef<M>

where M: Serialize + Send + 'static, E: ShardExtractor<M>,

Return an entity ref using a custom extractor.

pub async fn allocation_table( &self, type_name: impl Into<String>, ) -> ShardingResult<ShardAllocationTable>

Return the cached allocation table known by this region.

pub async fn rebalance_rounds(&self) -> ShardingResult<Vec<RebalanceRound>>

Return rebalance rounds recorded by this region when it was coordinator.

pub async fn shutdown(&self)

Stop local sharding tasks. Dropping the cluster agent also clears the DCP provider.

Trait Implementations

impl Clone for ShardingHandle

fn clone(&self) -> ShardingHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.