Struct EntityRef 

pub struct EntityRef<M> { /* private fields */ }

Reference to one entity.

Implementations

impl<M> EntityRef<M>

where M: Serialize + Send + 'static,

pub fn entity_id(&self) -> &str

Entity id.

pub fn shard_id(&self) -> &str

Shard id.

pub async fn tell(&self, message: M) -> ShardingResult<()>

Send one message at-most-once.

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

Passivate this entity if it is currently running.

The entity actor is stopped and removed from the local runtime on its current owner. A later message respawns the entity on demand. If the shard is moving, passivation is ordered through the same bounded handoff buffer as user messages.

pub async fn ask<R, F>( &self, timeout: Duration, make_message: F, ) -> ShardingResult<R>

where R: Serialize + DeserializeOwned + Send + 'static, F: FnOnce(ReplyPort<R>) -> M,

Send one message that carries a sharding ReplyPort.

Trait Implementations

impl<M> Clone for EntityRef<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.