Struct mesh_channel::MpscReceiver

pub struct MpscReceiver<T> { /* private fields */ }

Receiver type for mpsc_channel().

Implementations

impl<T: MeshField> MpscReceiver<T>

pub fn upcast<U: MeshField>(self) -> MpscReceiver<U>

where Self: Upcast<MpscReceiver<U>>,

Upcasts this receiver to one that can receive values whose encoding is a superset of T’s.

pub fn force_downcast<U: MeshField>(self) -> MpscReceiver<U>

where MpscReceiver<U>: Upcast<Self>,

Downcasts this receiver to one that can receive values whose encoding is a subset of T’s.

Although this is memory safe, it can cause decoding failures if the associated sender sends values that don’t decode to U.

impl<T: 'static + Send> MpscReceiver<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 sender(&mut self) -> MpscSender<T>

Creates a new sender for sending data to this receiver.

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

pub fn recv(&mut self) -> impl Future<Output = Result<T, RecvError>> + '_

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

Returns immediately when the channel is closed or failed.

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

Trait Implementations

impl<T> Debug for MpscReceiver<T>

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

Formats the value using the given formatter.

impl<T: 'static + Send> Default for MpscReceiver<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> DefaultEncoding for MpscReceiver<T>

where T: MeshField,

type Encoding = TableEncoder

The encoding to use for the serialization.

impl<T: 'static + Send> FusedStream for MpscReceiver<T>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T: 'static + Send> Stream for MpscReceiver<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.

impl<'encoding, T> StructDecodeMetadata<'encoding, Resource> for MpscReceiver<T>

where T: MeshField,

const DECODERS: &'static [ErasedDecoderEntry] = _

The list of decoder vtables.

impl<T> StructEncodeMetadata<Resource> for MpscReceiver<T>

where T: MeshField,

const ENCODERS: &'static [ErasedEncoderEntry] = _

The list of encoder vtables.

impl<T> StructMetadata for MpscReceiver<T>

where T: MeshField,

const NUMBERS: &'static [u32] = _

The field numbers for each field.

const OFFSETS: &'static [usize] = _

The byte offset to each field within the struct.

impl<T, U> Downcast<MpscReceiver<U>> for MpscReceiver<T>

where T: Downcast<U>,