Struct ksched::mpsc::Receiver

pub struct Receiver<T>(_);

The receiving end of a unbounded mpsc channel.

This value is created by the channel function.

Implementations

impl<T> Receiver<T>

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

Receives the next value for this receiver.

None is returned when all Sender halves have dropped, indicating that no further values can be sent on the channel.

Examples

use ksched::sync::mpsc;
use ksched::task;

let (tx, mut rx) = mpsc::channel().unwrap();

task::spawn(async move {
    tx.send("hello").unwrap();
});

assert_eq!(Some("hello"), rx.recv().await);
assert_eq!(None, rx.recv().await);

Values are buffered:

use ksched::sync::mpsc;
let (tx, mut rx) = mpsc::channel().unwrap();

tx.send("hello").unwrap();
tx.send("world").unwrap();

assert_eq!(Some("hello"), rx.recv().await);
assert_eq!(Some("world"), rx.recv().await);

pub fn close(&mut self)

Closes the receiving half of a channel, without dropping it.

This prevents any further messages from being sent on the channel while still enabling the receiver to drain messages that are buffered.

Trait Implementations

impl<T: Debug> Debug for Receiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.