Struct MAsyncTx

Source

pub struct MAsyncTx<F: Flavor>(/* private fields */);

Expand description

A multi-producer (sender) that works in an async context.

Inherits from AsyncTx<T> and implements Clone. Additional methods in ChannelShared can be accessed through Deref.

You can use into() to convert it to AsyncTx<T>.

MAsyncTx can be converted into MTx via the From trait, which means you can have two types of senders, both within async and blocking contexts, for the same channel.

Implementations§

Source §

impl<F: Flavor> MAsyncTx<F>

Source

pub fn into_sink(self) -> AsyncSink<F>

Source

pub fn into_blocking(self) -> MTx<F>

Methods from Deref<Target = AsyncTx<F>>§

Source

pub fn is_disconnected(&self) -> bool

Return true if the other side has closed

Source

pub fn send<'a>(&'a self, item: F::Item) -> SendFuture<'a, F> ⓘ

Sends a message. This method will await until the message is sent or the channel is closed.

This function is cancellation-safe, so it’s safe to use with timeout() and the select! macro. When a SendFuture is dropped, no message will be sent. However, the original message cannot be returned due to API limitations. For timeout scenarios, we recommend using AsyncTx::send_timeout(), which returns the message in a SendTimeoutError.

Returns Ok(()) on success.

Returns Err(SendError) if the receiver has been dropped.

Source

pub fn try_send(&self, item: F::Item) -> Result<(), TrySendError<F::Item>>

Attempts to send a message without blocking.

Returns Ok(()) when successful.

Returns Err(TrySendError::Full) if the channel is full.

Returns Err(TrySendError::Disconnected) if the receiver has been dropped.

Source

pub fn send_timeout( &self, item: F::Item, duration: Duration, ) -> SendTimeoutFuture<'_, F, Sleep, ()> ⓘ

Available on crate feature tokio only.

Sends a message with a timeout. Will await when channel is full.

The behavior is atomic: the message is either sent successfully or returned with error.

Returns Ok(()) when successful.

Returns Err(SendTimeoutError::Timeout) if the operation timed out. The error contains the message that failed to be sent.

Returns Err(SendTimeoutError::Disconnected) if the receiver has been dropped. The error contains the message that failed to be sent.

Source

pub fn send_timeout( &self, item: F::Item, duration: Duration, ) -> SendTimeoutFuture<'_, F, impl Future<Output = ()>, ()> ⓘ

Available on crate feature async_std only.

Source

pub fn send_with_timer<FR, R>( &self, item: F::Item, fut: FR, ) -> SendTimeoutFuture<'_, F, FR, R> ⓘ
where FR: Future<Output = R>,

Sends a message with a custom timer function (from other async runtime).

The behavior is atomic: the message is either sent successfully or returned with error.

Returns Ok(()) when successful.

Returns Err(SendTimeoutError::Timeout) if the operation timed out. The error contains the message that failed to be sent.

Returns Err(SendTimeoutError::Disconnected) if the receiver has been dropped. The error contains the message that failed to be sent.

§Argument:

fut: The sleep function. It’s possible to wrap this function with cancelable handle, you can control when to stop polling. the return value of fut is ignore. We add generic R just in order to support smol::Timer.

§Example:

extern crate smol;
use std::time::Duration;
use crossfire::*;
async fn foo() {
    let (tx, rx) = mpmc::bounded_async::<usize>(10);
    match tx.send_with_timer(1, smol::Timer::after(Duration::from_secs(1))).await {
        Ok(_)=>{
            println!("message sent");
        }
        Err(SendTimeoutError::Timeout(_item))=>{
            println!("send timeout");
        }
        Err(SendTimeoutError::Disconnected(_item))=>{
            println!("receiver-side closed");
        }
    }
}