Struct relay_system::Receiver

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

Inbound channel for messages sent through an Addr.

This channel is meant to be polled in a Service.

Instances are created automatically when spawning a service, or can be created through channel. The channel closes when all associated Addrs are dropped.

Implementations

impl<I: Interface> Receiver<I>

pub async fn recv(&mut self) -> Option<I>

Receives the next value for this receiver.

This method returns None if the channel has been closed and there are no remaining messages in the channel’s buffer. This indicates that no further values can ever be received from this Receiver. The channel is closed when all senders have been dropped.

If there are no messages in the channel’s buffer, but the channel has not yet been closed, this method will sleep until a message is sent or the channel is closed.

Trait Implementations

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

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

Formats the value using the given formatter.