Struct bastion::children_ref::ChildrenRef

pub struct ChildrenRef { /* fields omitted */ }

A "reference" to a children group, allowing to communicate with it.

Implementations

impl ChildrenRef

pub fn id(&self) -> &BastionId

Returns the identifier of the children group this ChildrenRef is referencing.

Note that the children group's identifier is reset when it is restarted.

Example

let children_ref = Bastion::children(|children| {
    // ...
}).expect("Couldn't create the children group.");

let children_id: &BastionId = children_ref.id();

pub fn dispatchers(&self) -> &Vec<DispatcherType>

Returns a list of dispatcher names that can be used for communication with other actors in the same group(s).

Example

let dispatchers = children_ref.dispatchers();

pub fn elems(&self) -> &[ChildRef]

Returns a list of ChildRef referencing the elements of the children group this ChildrenRef is referencing.

Example

let elems: &[ChildRef] = children_ref.elems();

pub fn broadcast<M: Message>(&self, msg: M) -> Result<(), M>

Sends a message to the children group this ChildrenRef is referencing which will then send it to all of its elements.

An alternative would be to use elems to get all the elements of the group and then send the message to all of them.

This method returns () if it succeeded, or Err(msg) otherwise.

Arguments

• msg - The message to send.

Example

let msg = "A message containing data.";
children_ref.broadcast(msg).expect("Couldn't send the message.");

// And then in every of the children group's elements' futures...
msg! { ctx.recv().await?,
    ref msg: &'static str => {
        assert_eq!(msg, &"A message containing data.");
    };
    // We are only sending a `&'static str` in this
    // example, so we know that this won't happen...
    _: _ => ();
}

pub fn stop(&self) -> Result<(), ()>

Sends a message to the children group this ChildrenRef is referencing to tell it to stop all of its running elements.

This method returns () if it succeeded, or Err(()) otherwise.

Example

children_ref.stop().expect("Couldn't send the message.");

pub fn kill(&self) -> Result<(), ()>

Sends a message to the children group this ChildrenRef is referencing to tell it to kill all of its running elements.

This method returns () if it succeeded, or Err(()) otherwise.

Example

children_ref.kill().expect("Couldn't send the message.");

pub fn path(&self) -> &Arc<BastionPath>

Returns the BastionPath of this ChildrenRef

Trait Implementations

impl Clone for ChildrenRef

fn clone(&self) -> ChildrenRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChildrenRef

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

Formats the value using the given formatter.

impl Eq for ChildrenRef

impl PartialEq<ChildrenRef> for ChildrenRef

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.