pub struct Sender<T> { /* fields omitted */ }
The sending side of a channel.
use std::thread;
use crossbeam_channel::unbounded;
let (s1, r) = unbounded();
let s2 = s1.clone();
thread::spawn(move || s1.send(1).unwrap());
thread::spawn(move || s2.send(2).unwrap());
let msg1 = r.recv().unwrap();
let msg2 = r.recv().unwrap();
assert_eq!(msg1 + msg2, 3);
Attempts to send a message into the channel without blocking.
This method will either send a message into the channel immediately or return an error if
the channel is full or disconnected. The returned error contains the original message.
If called on a zero-capacity channel, this method will send the message only if there
happens to be a receive operation on the other side of the channel at the same time.
use crossbeam_channel::{bounded, TrySendError};
let (s, r) = bounded(1);
assert_eq!(s.try_send(1), Ok(()));
assert_eq!(s.try_send(2), Err(TrySendError::Full(2)));
drop(r);
assert_eq!(s.try_send(3), Err(TrySendError::Disconnected(3)));
Blocks the current thread until a message is sent or the channel is disconnected.
If the channel is full and not disconnected, this call will block until the send operation
can proceed. If the channel becomes disconnected, this call will wake up and return an
error. The returned error contains the original message.
If called on a zero-capacity channel, this method will wait for a receive operation to
appear on the other side of the channel.
use std::thread;
use std::time::Duration;
use crossbeam_channel::{bounded, SendError};
let (s, r) = bounded(1);
assert_eq!(s.send(1), Ok(()));
thread::spawn(move || {
assert_eq!(r.recv(), Ok(1));
thread::sleep(Duration::from_secs(1));
drop(r);
});
assert_eq!(s.send(2), Ok(()));
assert_eq!(s.send(3), Err(SendError(3)));
Waits for a message to be sent into the channel, but only for a limited time.
If the channel is full and not disconnected, this call will block until the send operation
can proceed or the operation times out. If the channel becomes disconnected, this call will
wake up and return an error. The returned error contains the original message.
If called on a zero-capacity channel, this method will wait for a receive operation to
appear on the other side of the channel.
use std::thread;
use std::time::Duration;
use crossbeam_channel::{bounded, SendTimeoutError};
let (s, r) = bounded(0);
thread::spawn(move || {
thread::sleep(Duration::from_secs(1));
assert_eq!(r.recv(), Ok(2));
drop(r);
});
assert_eq!(
s.send_timeout(1, Duration::from_millis(500)),
Err(SendTimeoutError::Timeout(1)),
);
assert_eq!(
s.send_timeout(2, Duration::from_secs(1)),
Ok(()),
);
assert_eq!(
s.send_timeout(3, Duration::from_millis(500)),
Err(SendTimeoutError::Disconnected(3)),
);
Returns true
if the channel is empty.
Note: Zero-capacity channels are always empty.
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
assert!(s.is_empty());
s.send(0).unwrap();
assert!(!s.is_empty());
Returns true
if the channel is full.
Note: Zero-capacity channels are always full.
use crossbeam_channel::bounded;
let (s, r) = bounded(1);
assert!(!s.is_full());
s.send(0).unwrap();
assert!(s.is_full());
Returns the number of messages in the channel.
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
assert_eq!(s.len(), 0);
s.send(1).unwrap();
s.send(2).unwrap();
assert_eq!(s.len(), 2);
If the channel is bounded, returns its capacity.
use crossbeam_channel::{bounded, unbounded};
let (s, _) = unbounded::<i32>();
assert_eq!(s.capacity(), None);
let (s, _) = bounded::<i32>(5);
assert_eq!(s.capacity(), Some(5));
let (s, _) = bounded::<i32>(0);
assert_eq!(s.capacity(), Some(0));
Executes the destructor for this type. Read more
Performs copy-assignment from source
. Read more
Formats the value using the given formatter. Read more
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static