Struct relay_system::Addr

pub struct Addr<I: Interface> { /* private fields */ }

The address of a Service.

Addresses allow to send messages to a service that implements a corresponding Interface as long as the service is running.

Addresses can be freely cloned. When the last clone is dropped, the message channel of the service closes permanently, which signals to the service that it can shut down.

Implementations

impl<I: Interface> Addr<I>

pub fn send<M>(&self, message: M) -> <I::Response as MessageResponse>::Output

where I: FromMessage<M>,

Sends a message to the service and returns the response.

Depending on the message’s response behavior, this either returns a future resolving to the return value, or does not return anything for fire-and-forget messages. The communication channel with the service is unbounded, so backlogs could occur when sending too many messages.

Sending asynchronous messages can fail with Err(SendError) if the service has shut down. The result of asynchronous messages does not have to be awaited. The message will be delivered and handled regardless:

pub fn recipient<M>(self) -> Recipient<M, I::Response>

where I: FromMessage<M>,

Returns a handle that can receive a given message independent of the interface.

See Recipient for more information and examples.

pub fn is_empty(&self) -> bool

Returns wether the queue is currently empty.

pub fn len(&self) -> u64

Returns the current queue size.

pub fn custom() -> (Self, UnboundedReceiver<I>)

Custom address used for testing.

Returns the receiving end of the channel for inspection.

pub fn dummy() -> Self

Dummy address used for testing.

Trait Implementations

impl<I: Interface> Clone for Addr<I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Interface> Debug for Addr<I>

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

Formats the value using the given formatter.