Struct side_futures::FuturesReceiver

pub struct FuturesReceiver(_);

Receiver channel for futures sent with sender, can be used to run received futures manually or (most likely) using FuturesReceiver::run_receiver() method

Implementations

impl FuturesReceiver

pub async fn run_receiver<S, R>(self, spawner: S) where
    S: Fn(Pin<Box<dyn Future<Output = ()> + Send>>) -> R, 

Run futures sent by sender using runtime-specific tasks spawner

Methods from Deref<Target = UnboundedReceiver<Pin<Box<dyn Future<Output = ()> + Send>>>>

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.

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

Tries to receive the next message without notifying a context if empty.

It is not recommended to call this function from inside of a future, only when you’ve otherwise arranged to be notified when the channel is no longer empty.

This function returns:

• Ok(Some(t)) when message is fetched
• Ok(None) when channel is closed and no messages left in the queue
• Err(e) when there are no messages available, but channel is not yet closed

Trait Implementations

impl Debug for FuturesReceiver

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

Formats the value using the given formatter.

impl Deref for FuturesReceiver

type Target = UnboundedReceiver<Pin<Box<dyn Future<Output = ()> + Send>>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FuturesReceiver

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.