Struct Receiver

pub struct Receiver<T>(/* private fields */);

The receiving half of a channel returned by channel.

Implementations

impl<T> Receiver<T>

pub fn new() -> Self

Creates a new receiver with no senders.

Receives will fail with RecvError::Closed until Self::sender is called.

pub fn recv(&mut self) -> Recv<'_, T>

Consumes and returns the next message, waiting until one is available.

Returns immediately when the channel is closed or failed.

let (send, mut recv) = channel();
send.send(5u32);
drop(send);
assert_eq!(recv.recv().await.unwrap(), 5);
assert!(matches!(recv.recv().await.unwrap_err(), RecvError::Closed));

pub fn try_recv(&mut self) -> Result<T, TryRecvError>

Consumes and returns the next message, if there is one.

Otherwise, returns whether the channel is empty, closed, or failed.

let (send, mut recv) = channel();
send.send(5u32);
drop(send);
assert_eq!(recv.try_recv().unwrap(), 5);
assert!(matches!(recv.try_recv().unwrap_err(), TryRecvError::Closed));

pub fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll<Result<T, RecvError>>

Polls for the next message.

If one is available, consumes and returns it. If the channel is closed or failed, fails. Otherwise, registers the current task to wake when a message is available or the channel is closed or fails.

pub fn sender(&mut self) -> Sender<T>

Creates a new sender for sending data to this receiver.

Note that this may transition the channel from the closed to open state.

impl<T: MeshField> Receiver<T>

pub fn bridge(self, sender: Sender<T>)

Bridges this and sender together, consuming both self and sender.

See Sender::bridge for more details.

Trait Implementations

impl<T> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> Default for Receiver<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: MeshField> DefaultEncoding for Receiver<T>

type Encoding = PortField

The encoding to use for the serialization.

impl<T: MeshField> From<Port> for Receiver<T>

fn from(port: Port) -> Self

Converts to this type from the input type.

impl<T: MeshField> From<Receiver<T>> for Port

fn from(receiver: Receiver<T>) -> Self

Converts to this type from the input type.

impl<T> FusedStream for Receiver<T>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T> Stream for Receiver<T>

type Item = T

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.