Struct AsyncTx

pub struct AsyncTx<T> { /* private fields */ }

Single producer (sender) that works in async context.

Additional methods can be accessed through Deref<Target=ChannelShared>.

AsyncTx can be converted into Tx via From trait, that means you can have two types of senders both within async context and blocking context to the same channel.

NOTE: AsyncTx is not Clone, nor Sync. If you need concurrent access, use MAsyncTx instead.

AsyncTx has Send marker, can be moved to other coroutine. The following code is OK :

use crossfire::*;
async fn foo() {
    let (tx, rx) = spsc::bounded_async::<usize>(100);
    tokio::spawn(async move {
         let _ = tx.send(2).await;
    });
    drop(rx);
}

Because AsyncTx does not have Sync marker, using Arc<AsyncTx> will lose Send marker.

For your safety, the following code should not compile:

use crossfire::*;
use std::sync::Arc;
async fn foo() {
    let (tx, rx) = spsc::bounded_async::<usize>(100);
    let tx = Arc::new(tx);
    tokio::spawn(async move {
         let _ = tx.send(2).await;
    });
    drop(rx);
}

Implementations

impl<T> AsyncTx<T>

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

Try to send message, non-blocking

Returns Ok(()) when successful.

Returns Err(TrySendError::Full) on channel full for bounded channel.

Returns Err(TrySendError::Disconnected) when all Rx dropped.

pub fn len(&self) -> usize

The number of messages in the channel at the moment

pub fn capacity(&self) -> Option<usize>

The capacity of the channel

pub fn is_empty(&self) -> bool

Whether channel is empty at the moment

pub fn is_full(&self) -> bool

Whether the channel is full at the moment

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

pub fn into_blocking(self) -> Tx<T>

impl<T: Unpin + Send + 'static> AsyncTx<T>

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

Send message. Will await when channel is full.

Returns Ok(()) on successful.

Returns Err(SendError) when all Rx is dropped.

pub fn make_send_future<'a>(&'a self, item: T) -> SendFuture<'a, T>

👎Deprecated

Use send() instead

pub fn send_timeout<'a>( &'a self, item: T, duration: Duration, ) -> SendTimeoutFuture<'a, T>

Available on crate features tokio or async_std only.

Waits for a message to be sent into the channel, but only for a limited time. Will await when channel is full.

The behavior is atomic, either message sent successfully or returned on error.

Returns Ok(()) when successful.

Returns Err(SendTimeoutError::Timeout) when the operation timed out.

Returns Err(SendTimeoutError::Disconnected) when all Rx dropped.

pub fn send_blocking(&self, item: T) -> Result<(), SendError<T>>

Send a message while blocking the current thread. Be careful!

Returns Ok(())on successful.

Returns Err(SendError) when all Rx is dropped.

NOTE: Do not use it in async context otherwise will block the runtime.

Methods from Deref<Target = ChannelShared>

pub fn is_disconnected(&self) -> bool

Return true if all the senders or receivers are dropped

pub fn get_tx_count(&self) -> usize

Get the count of alive senders

pub fn get_rx_count(&self) -> usize

Get the count of alive receivers

pub fn get_wakers_count(&self) -> (usize, usize)

Just for debugging purpose, to monitor queue size

Trait Implementations

impl<T> AsRef<ChannelShared> for AsyncTx<T>

fn as_ref(&self) -> &ChannelShared

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Unpin + Send + 'static> AsyncTxTrait<T> for AsyncTx<T>

fn try_send(&self, item: T) -> Result<(), TrySendError<T>>

Try to send message, non-blocking

fn len(&self) -> usize

The number of messages in the channel at the moment

fn capacity(&self) -> Option<usize>

The capacity of the channel, None for unbounded.

fn is_empty(&self) -> bool

Whether channel is empty at the moment

fn is_full(&self) -> bool

Whether the channel is full at the moment

fn send<'a>(&'a self, item: T) -> SendFuture<'a, T>

Send message. Will await when channel is full.

fn send_timeout<'a>( &'a self, item: T, duration: Duration, ) -> SendTimeoutFuture<'a, T>

Available on crate features tokio or async_std only.

Waits for a message to be sent into the channel, but only for a limited time. Will await when channel is full.

fn is_disconnected(&self) -> bool

Return true if the other side has closed

impl<T> Debug for AsyncTx<T>

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

Formats the value using the given formatter.

impl<T> Deref for AsyncTx<T>

type Target = ChannelShared

The resulting type after dereferencing.

fn deref(&self) -> &ChannelShared

Dereferences the value.

impl<T> Display for AsyncTx<T>

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

Formats the value using the given formatter.

impl<T> Drop for AsyncTx<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Unpin + Send + 'static> From<AsyncTx<T>> for AsyncSink<T>

fn from(tx: AsyncTx<T>) -> Self

Converts to this type from the input type.

impl<T> From<AsyncTx<T>> for Tx<T>

fn from(value: AsyncTx<T>) -> Self

Converts to this type from the input type.

impl<T> From<MAsyncTx<T>> for AsyncTx<T>

fn from(tx: MAsyncTx<T>) -> Self

Converts to this type from the input type.

impl<T: Send> Send for AsyncTx<T>