Struct Tx 

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

A single producer (sender) that works in a blocking context.

Additional methods in ChannelShared can be accessed through Deref.

NOTE: Tx is not Clone or Sync. If you need concurrent access, use MTx instead.

Tx has a Send marker and can be moved to other threads. The following code is OK:

use crossfire::*;
let (tx, rx) = spsc::bounded_blocking::<usize>(100);
std::thread::spawn(move || {
    let _ = tx.send(1);
});
drop(rx);

Because Tx does not have a Sync marker, using Arc<Tx> will lose the Send marker.

For your safety, the following code should not compile:

use crossfire::*;
use std::sync::Arc;
let (tx, rx) = spsc::bounded_blocking::<usize>(100);
let tx = Arc::new(tx);
std::thread::spawn(move || {
    let _ = tx.send(1);
});
drop(rx);

Implementations

impl<T: Send + 'static> Tx<T>

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

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

Returns Ok(()) on success.

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

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

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.

pub fn send_timeout( &self, item: T, timeout: Duration, ) -> Result<(), SendTimeoutError<T>>

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

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

Returns Ok(()) when successful.

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

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

Methods from Deref<Target = ChannelShared<T>>

pub fn len(&self) -> usize

The number of messages in the channel.

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

The capacity of the channel. Returns None for unbounded channels.

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

pub fn is_full(&self) -> bool

Returns true if the channel is full.

pub fn is_disconnected(&self) -> bool

Returns true if all senders or receivers have been dropped.

pub fn get_tx_count(&self) -> usize

Returns the number of senders for the channel.

pub fn get_rx_count(&self) -> usize

Returns the number of receivers for the channel.

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

Returns the number of wakers for senders and receivers. For debugging purposes.

Trait Implementations

impl<T> AsRef<ChannelShared<T>> for Tx<T>

fn as_ref(&self) -> &ChannelShared<T>

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

impl<T: Send + 'static> BlockingTxTrait<T> for Tx<T>

fn clone_to_vec(self, _count: usize) -> Vec<Self>

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

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

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

Attempts to send a message without blocking.

fn send_timeout( &self, item: T, timeout: Duration, ) -> Result<(), SendTimeoutError<T>>

Sends a message with a timeout. Will block when channel is empty.

fn len(&self) -> usize

The number of messages in the channel at the moment

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

The capacity of the channel, return None for unbounded channel.

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 is_disconnected(&self) -> bool

Return true if the other side has closed

impl<T> Debug for Tx<T>

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

Formats the value using the given formatter.

impl<T> Deref for Tx<T>

type Target = ChannelShared<T>

The resulting type after dereferencing.

fn deref(&self) -> &ChannelShared<T>

Dereferences the value.

impl<T> Display for Tx<T>

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

Formats the value using the given formatter.

impl<T> Drop for Tx<T>

fn drop(&mut self)

Executes the destructor for this 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<MTx<T>> for Tx<T>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<T: Send> Send for Tx<T>