Struct Address 

pub struct Address<S>
where
    S: Puppet,
{
    pub pid: Pid,
    /* private fields */
}

Represents an address to which messages can be sent to a puppet.

An Address is returned when spawning a puppet and provides a more efficient way to send messages compared to using pptr.send(), as it involves one less layer of indirection.

Example Usage

let address = pptr.spawn::<Master, Puppet>(builder).await?;
let status = address.get_status();

Fields

pid: Pid

Implementations

impl<S> Address<S>

where S: Puppet,

pub fn get_status(&self) -> PuppetStatus

Returns the current lifecycle status of the puppet.

Example Usage

let status = address.get_status();

pub fn subscribe_status(&self) -> Receiver<PuppetStatus>

Subscribes to changes in the puppet’s lifecycle status.

Returns a watch::Receiver that can be used to receive status change notifications.

Example Usage

let status_rx = address.status_subscribe();

pub fn on_status_change<F>(&self, f: F)

where F: Fn(PuppetStatus) + Send + 'static,

Registers a callback function to be invoked when the puppet’s status changes.

The provided callback function will be executed asynchronously whenever the puppet’s lifecycle status changes.

Example Usage

address.on_status_change(|status| {
    println!("Puppet status changed: {:?}", status);
});

pub fn send<E>(&self, message: E) -> Result<(), PostmanError>

where S: Handler<E>, E: Message + 'static,

Sends a message of type E to the puppet.

Returns a Result indicating the success or failure of the send operation.

Errors

Returns a PostmanError if the message fails to send.

Example Usage

let result = address.send(MyMessage::new()).await;

pub async fn ask<E>( &self, message: E, ) -> Result<ResponseFor<S, E>, PostmanError>

where S: Handler<E>, E: Message + 'static,

Sends a message of type E to the puppet and awaits a response.

Returns a Result containing the response or an error.

Errors

Returns a PostmanError if the message fails to send or receive a response.

Example Usage

let response = address.ask(MyMessage::new()).await?;

pub async fn ask_with_timeout<E>( &self, message: E, duration: Duration, ) -> Result<ResponseFor<S, E>, PostmanError>

where S: Handler<E>, E: Message + 'static,

Sends a message of type E to the puppet with a timeout and awaits a response.

Returns a Result containing the response or an error.

Errors

Returns a PostmanError if the message fails to send or receive a response within the timeout duration.

Example Usage

let response = address.ask_with_timeout(MyMessage::new(), Duration::from_secs(5)).await?;

pub async fn spawn<P>(&self, puppet: P) -> Result<Address<P>, PuppetError>

where P: Puppet,

Spawns a new puppet of type P using the provided PuppetBuilder and sets the current puppet as the puppet’s master.

Returns an Address<P> for the newly spawned puppet.

Errors

Returns a PuppetError if the puppet fails to spawn or initialize.

Example Usage

let address = address.spawn::<Puppet>(builder).await?;

Trait Implementations

impl<S> Clone for Address<S>

where S: Puppet + Clone,

fn clone(&self) -> Address<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Puppet> Debug for Address<S>

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

Formats the value using the given formatter.

impl<P> Display for Address<P>

where P: Puppet,

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

Formats the value using the given formatter.