Struct glommio::channels::local_channel::LocalReceiver

pub struct LocalReceiver<T> { /* fields omitted */ }

Receive endpoint to the local_channel

The LocalReceiver provides an interface compatible with StreamExt and will keep yielding elements until the sender is destroyed.

Examples

use futures_lite::StreamExt;
use glommio::{channels::local_channel, Local, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let (sender, mut receiver) = local_channel::new_unbounded();

    let h = Local::local(async move {
        let sum = receiver.stream().fold(0, |acc, x| acc + x).await;
        assert_eq!(sum, 45);
    })
    .detach();

    for i in 0..10 {
        sender.try_send(i);
    }
    drop(sender);
    h.await;
});

Implementations

impl<T> LocalReceiver<T>

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

Receives data from this channel

If the sender is no longer available it returns None. Otherwise block until an item is available and returns it wrapped in Some

Notice that this is also available as a Stream. Whether to consume from a stream or recv is up to the application. The biggest difference is that StreamExt’s next method takes a mutable reference to self. If the LocalReceiver is, say, behind an Rc it may be more ergonomic to recv.

Examples

use glommio::{channels::local_channel, Local, LocalExecutor};

let ex = LocalExecutor::default();
ex.run(async move {
    let (sender, receiver) = local_channel::new_bounded(1);
    sender.send(0).await.unwrap();
    let x = receiver.recv().await.unwrap();
    assert_eq!(x, 0);
});

pub fn stream(&self) -> impl Stream<Item = T> + '_

Converts receiver into the [‘Stream’] instance. Each [‘Stream’] instance may handle only single receiver and can not be shared between [‘Tasks’].

Trait Implementations

impl<T: Debug> Debug for LocalReceiver<T>

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

Formats the value using the given formatter.

impl<T> Drop for LocalReceiver<T>

fn drop(&mut self)

Executes the destructor for this type.