Struct RSender

#[repr(C)]
pub struct RSender<T> { /* private fields */ }

The sender end of a channel, which can be either bounded or unbounded.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

let (tx, rx) = mpmc::bounded::<&'static str>(1024);

std::thread::spawn(move || {
    for _ in 0..4 {
        tx.send("Are we there yet.").unwrap();
    }
});

assert_eq!(rx.recv().unwrap(), "Are we there yet.");
assert_eq!(rx.recv().unwrap(), "Are we there yet.");
assert_eq!(rx.recv().unwrap(), "Are we there yet.");
assert_eq!(rx.recv().unwrap(), "Are we there yet.");
assert!(rx.recv().is_err());

Implementations

impl<T> RSender<T>

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

Blocks until value is either sent,or the the other end is disconnected.

If the channel queue is full,this will block to send value.

If the channel is disconnected,this will return an error with value.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

let (tx, rx) = mpmc::bounded::<u32>(3);

tx.send(1057).unwrap();

drop(rx);
assert!(tx.send(0).is_err());

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

Immediately sends value,or returns with an error.

An error will be returned in these 2 conditions:

• the channel is full.

• the channel has been disconnected.

If the channel has a capacity of 0,it will only send value if the other end is calling recv.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

let (tx, rx) = mpmc::bounded::<bool>(1);

tx.try_send(true).unwrap();
assert!(tx.try_send(true).unwrap_err().is_full());

drop(rx);
assert!(tx.try_send(false).unwrap_err().is_disconnected());

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

Blocks until a timeout to send value.

An error will be returned in these 2 conditions:

• the value could not be sent before the timeout.

• the channel has been disconnected.

If the channel has a capacity of 0,it will only send value if the other end calls recv before the timeout.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

use std::time::Duration;

let (tx, rx) = mpmc::bounded::<()>(1);

let timeout = Duration::from_millis(1);

tx.send_timeout((), timeout).unwrap();
assert!(tx.send_timeout((), timeout).unwrap_err().is_timeout());

drop(rx);
assert!(tx.send_timeout((), timeout).unwrap_err().is_disconnected());

pub fn is_empty(&self) -> bool

Returns true if there are no values in the channel queue.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

let (tx, rx) = mpmc::bounded::<()>(1);

assert!(tx.is_empty());

tx.send(()).unwrap();
assert!(!tx.is_empty());

rx.recv().unwrap();
assert!(tx.is_empty());

pub fn is_full(&self) -> bool

Returns true if the channel queue is full.

This always returns true for channels constructed with bounded(0).

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

let (tx, rx) = mpmc::bounded::<()>(2);

assert!(!tx.is_full());

tx.send(()).unwrap();
assert!(!tx.is_full());

tx.send(()).unwrap();
assert!(tx.is_full());

rx.recv().unwrap();
assert!(!tx.is_full());

pub fn len(&self) -> usize

Returns the amount of values in the channel queue.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

let (tx, rx) = mpmc::bounded::<()>(2);

assert_eq!(tx.len(), 0);

tx.send(()).unwrap();
assert_eq!(tx.len(), 1);

tx.send(()).unwrap();
assert_eq!(tx.len(), 2);

rx.recv().unwrap();
assert_eq!(tx.len(), 1);

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

Returns the amount of values the channel queue can hold.

This returns None if the channel is unbounded.

Example

use abi_stable::external_types::crossbeam_channel as mpmc;

{
    let (tx, rx) = mpmc::bounded::<()>(2);
    assert_eq!(tx.capacity(), Some(2));
}
{
    let (tx, rx) = mpmc::unbounded::<()>();
    assert_eq!(tx.capacity(), None);
}

Trait Implementations

impl<T> Clone for RSender<T>

fn clone(&self) -> Self

Clones this channel end,getting another handle into the channel.

Note that this allocates an RBox<_>.

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

Performs copy-assignment from source.

impl<T> Debug for RSender<T>

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

Formats the value using the given formatter.

impl<T> From<Sender<T>> for RSender<T>

fn from(this: Sender<T>) -> RSender<T>

Converts to this type from the input type.

impl<T> GetStaticEquivalent_ for RSender<T>

where T: __StableAbi,

type StaticEquivalent = _static_RSender<<T as GetStaticEquivalent_>::StaticEquivalent>

The 'static equivalent of Self

impl<T> StableAbi for RSender<T>

where T: __StableAbi,

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

impl<T: Send> Send for RSender<T>

impl<T: Send> Sync for RSender<T>