Struct heph::actor_ref::ActorGroup

pub struct ActorGroup<M> { /* fields omitted */ }

A group of ActorRefs used to send a message to multiple actors.

Implementations

impl<M> ActorGroup<M>

pub const fn empty() -> ActorGroup<M>

Creates an empty ActorGroup.

pub fn new<I>(actor_refs: I) -> ActorGroup<M> where
    I: IntoIterator<Item = ActorRef<M>>, 

Create a new ActorGroup.

pub fn len(&self) -> usize

Returns the number of actor references in the group.

pub fn is_empty(&self) -> bool

Returns true if the group is empty.

pub fn add(&mut self, actor_ref: ActorRef<M>)

Add an ActorRef to the group.

pub fn add_unique(&mut self, actor_ref: ActorRef<M>)

Add an ActorRef to the group, iff it’s not already in the group.

pub fn remove(&mut self, actor_ref: &ActorRef<M>)

Remove all actor references which point to the same actor as actor_ref.

pub fn remove_disconnected(&mut self)

Remove all actor references that have been disconnected.

pub fn make_unique(&mut self)

Make the group of actor references unique.

Removes all duplicate actor references.

pub fn try_send<Msg>(
    &self,
    msg: Msg,
    delivery: Delivery
) -> Result<(), SendError> where
    Msg: Into<M> + Clone, 

Attempts to send a message to all the actors in the group.

This can either send the message to a single actor, by using Delivery::ToOne, or to all actors in the group by using Delivery::ToAll.

When deliverying to all actors this will first clone the message and then try_sending it to each actor in the group. Note that this means it will clone before calling Into::into on the message. If the call to Into::into is expansive, or M is cheaper to clone than Msg it might be worthwhile to call msg.into() before calling this method.

This only returns an error if the group is empty, otherwise this will always return Ok(()).

See Sending messages for more details.

pub fn join_all<'r>(&'r self) -> JoinAll<'r, M>

Wait for all actors in this group to finish running.

This works the same way as ActorRef::join, but waits on a group of actors.

Trait Implementations

impl<M> Debug for ActorGroup<M>

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

Formats the value using the given formatter.

impl<M> Extend<ActorRef<M>> for ActorGroup<M>

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = ActorRef<M>>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<M> From<ActorRef<M>> for ActorGroup<M>

fn from(actor_ref: ActorRef<M>) -> ActorGroup<M>

Performs the conversion.

impl<M> FromIterator<ActorRef<M>> for ActorGroup<M>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = ActorRef<M>>, 

Creates a value from an iterator.