Struct bastion::path::BastionPath

pub struct BastionPath { /* fields omitted */ }

Represents a Path for a System, Supervisor, Children or Child.

BastionPath can be used to identify message senders. Later it will be used to route messages to a path.

Example

ctx.tell(&ctx.signature(), "Hello to myself").expect("Couldn't send a message");
msg! { ctx.recv().await?,
    ref msg: &'static str => {
        let path: &BastionPath = signature!().path();
        assert_eq!(path.elem(), ctx.signature().path().elem());
    };
    // We are only sending a `&'static str` in this
    // example, so we know that this won't happen...
    _: _ => ();
}

Implementations

impl BastionPath

pub fn id(&self) -> &BastionId

Returns the last element's id. If it's root or a dead_letters then &NIL_ID is returned.

Example

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

msg! { ctx.recv().await?,
    ref msg: &'static str => {
        let path = signature!().path();
        assert_eq!(path.id(), &NIL_ID);
    };
    // We are only sending a `&'static str` in this
    // example, so we know that this won't happen...
    _: _ => ();
}

pub fn elem(&self) -> &Option<BastionPathElement>

Returns a path element. If the path is root then None is returned.

Example

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

msg! { ctx.recv().await?,
    ref msg: &'static str => {
        let path = signature!().path();
        assert!(path.elem().as_ref().unwrap().is_children());
    };
    // We are only sending a `&'static str` in this
    // example, so we know that this won't happen...
    _: _ => ();
}

pub fn is_dead_letters(&self) -> bool

Checks whether BastionPath is a dead-letters path.

Example

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

msg! { ctx.recv().await?,
    ref msg: &'static str => {
        let path = signature!().path();
        assert!(path.is_dead_letters());
    };
    // We are only sending a `&'static str` in this
    // example, so we know that this won't happen...
    _: _ => ();
}

Trait Implementations

impl Clone for BastionPath

fn clone(&self) -> BastionPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BastionPath

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

Formats the value using the given formatter.

impl Display for BastionPath

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

Formats the value using the given formatter.