Struct side_futures::FuturesSender

pub struct FuturesSender(_);

Sender channel for futures to be received and spawned as executor tasks by receiver. Can be used to send futures manually or (most likely) using FuturesSender::send_future() method

Methods

impl FuturesSender

pub fn send_future(
    &self,
    future: impl Future<Output = ()> + Send + 'static
) -> Result<(), TrySendError<impl Future<Output = ()> + Send>>

Sending future for execution on a runtime

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

pub fn poll_ready(&self, &mut Context) -> Poll<Result<(), SendError>>

Check if the channel is ready to receive a message.

pub fn is_closed(&self) -> bool

Returns whether this channel is closed without needing a context.

pub fn close_channel(&self)

Closes this channel from the sender side, preventing any new messages.

pub fn disconnect(&mut self)

Disconnects this sender from the channel, closing it if there are no more senders left.

pub fn start_send(&mut self, msg: T) -> Result<(), SendError>

Send a message on the channel.

This method should only be called after poll_ready has been used to verify that the channel is ready to receive a message.

pub fn unbounded_send(&self, msg: T) -> Result<(), TrySendError<T>>

Sends a message along this channel.

This is an unbounded sender, so this function differs from Sink::send by ensuring the return type reflects that the channel is always ready to receive messages.

pub fn same_receiver(&self, other: &UnboundedSender<T>) -> bool

Returns whether the senders send to the same receiver.

pub fn hash_receiver<H>(&self, hasher: &mut H) where
    H: Hasher, 

Hashes the receiver into the provided hasher

Trait Implementations

impl Clone for FuturesSender

fn clone(&self) -> FuturesSender

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Deref for FuturesSender

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

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for FuturesSender

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

Mutably dereferences the value.