Struct mesh_channel::Receiver

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

The receiving half of a channel returned by channel.

Implementations

impl<T: MeshField> Receiver<T>

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

where Self: Upcast<Receiver<U>>,

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

let (send, recv) = channel::<Option<(u32, u16)>>();
let mut recv = recv.upcast::<Option<mesh_node::message::Message>>();
send.send(None);
send.send(Some((5, 4)));
assert!(block_on(recv.recv()).unwrap().is_none());
assert!(block_on(recv.recv()).unwrap().is_some());

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

where Receiver<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> Receiver<T>

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 recv( &mut self, ) -> impl Future<Output = Result<T, RecvError>> + Unpin + '_

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 poll_recv(&mut self, cx: &mut Context<'_>) -> Poll<Result<T, RecvError>>

Polls for the next message.

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

See Sender::bridge.

Trait Implementations

impl<T> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> DefaultEncoding for Receiver<T>

where T: MeshField,

type Encoding = TableEncoder

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(v: Receiver<T>) -> Self

Converts to this type from the input type.

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

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<T: 'static + Send> Stream for Receiver<T>

Stream implementation for a channel.

Note that the output item from this throws away the distinction between the channel being closed and the channel failing due to a node error or decoding error. This simplifies most code that does not care about this distinction.

If you need to distinguish between these cases, use Receiver::recv or Receiver::poll_recv.

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 Receiver<T>

where T: MeshField,

const DECODERS: &'static [ErasedDecoderEntry] = _

The list of decoder vtables.

impl<T> StructEncodeMetadata<Resource> for Receiver<T>

where T: MeshField,

const ENCODERS: &'static [ErasedEncoderEntry] = _

The list of encoder vtables.

impl<T> StructMetadata for Receiver<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: MeshField, U: MeshField> Downcast<Receiver<U>> for Receiver<T>

where (T,): Downcast<(U,)>,