Struct RemoteActorRegistry 

pub struct RemoteActorRegistry { /* private fields */ }

A registry of actors in the current process which can receive RemoteMessages.

The registry is a cheaply-cloneable concurrent map shared between a Node and all of its sessions. It lets sessions route inbound RemoteMessages to the proper actor in the same process.

An actor which implements the RemoteActor trait will be automatically registered in a Node’s registry when its address is encoded as a RemoteMessage for the first time. Users can also manually register an actor with a Node’s AddActor command.

Implementations

impl RemoteActorRegistry

pub fn new() -> Self

Constructs a new empty RemoteActorRegistry.

pub fn with_capacity(capacity: usize) -> Self

Constructs a new empty RemoteActorRegistry with the specified capacity.

pub fn capacity(&self) -> usize

Returns the number of actors the registry can hold without reallocating.

Locking behavior: May deadlock if called when holding a mutable reference into the registry.

pub fn len(&self) -> usize

Returns the number of actors currently in the registry.

Locking behavior: May deadlock if called when holding a mutable reference into the registry.

pub fn is_empty(&self) -> bool

Returns true if the registry contains no actors.

Locking behavior: May deadlock if called when holding a mutable reference into the registry.

pub fn retain<F>(&self, predicate: F)

where F: FnMut(u64, &Recipient<RemoteMessage>) -> bool,

Retains only the actors for which the predicate returns true.

Locking behavior: May deadlock if called when holding any sort of reference into the registry.

pub fn get(&self, index: u64) -> Option<Recipient<RemoteMessage>>

Returns an actor as a Recipient<RemoteMessage> corresponding to the given index.

If the actor’s mailbox is closed, this method removes it and returns None. This is different from the behavior of get on a normal HashMap.

Locking behavior: May deadlock if called when holding any sort of reference into the registry.

pub fn contains_index(&self, index: u64) -> bool

Returns true if the registry contains an actor for the given index.

Locking behavior: May deadlock if called when holding a mutable reference into the registry.

pub fn remove(&self, index: u64) -> Option<Recipient<RemoteMessage>>

Removes an actor by its index, returning the actor as a Recipient<RemoteMessage> if it was present in the registry.

Locking behavior: May deadlock if called when holding any sort of reference into the registry.

pub fn insert<A>(&self, actor: A) -> bool

where A: Into<Recipient<RemoteMessage>> + SenderId,

Inserts a new actor keyed by its index.

If the registry did not have this actor present, true is returned. If the registry did have this actor present, false is returned and the registry is not modified. This is different from the behavior of insert on a normal HashMap.

Re-registering the same address is a cheap lookup-no-op.

Locking behavior: May deadlock if called when holding any sort of reference into the registry.

Trait Implementations

impl Clone for RemoteActorRegistry

fn clone(&self) -> RemoteActorRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteActorRegistry

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

Formats the value using the given formatter.

impl Default for RemoteActorRegistry

fn default() -> RemoteActorRegistry

Returns the “default value” for a type.