pub struct Sender<T> { /* private fields */ }
Expand description
The sending side of a channel.
Examples
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);
Implementations
impl<T> Sender<T>
impl<T> Sender<T>
pub fn try_send(&self, msg: T) -> Result<(), TrySendError<T>>
pub fn try_send(&self, msg: T) -> Result<(), TrySendError<T>>
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.
Examples
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)));
pub fn send(&self, msg: T) -> Result<(), SendError<T>>
pub fn send(&self, msg: T) -> Result<(), SendError<T>>
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.
Examples
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)));
pub fn send_timeout(
&self,
msg: T,
timeout: Duration
) -> Result<(), SendTimeoutError<T>>
pub fn send_timeout(
&self,
msg: T,
timeout: Duration
) -> Result<(), SendTimeoutError<T>>
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.
Examples
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)),
);
pub fn send_deadline(
&self,
msg: T,
deadline: Instant
) -> Result<(), SendTimeoutError<T>>
pub fn send_deadline(
&self,
msg: T,
deadline: Instant
) -> Result<(), SendTimeoutError<T>>
Waits for a message to be sent into the channel, but only until a given deadline.
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.
Examples
use std::thread;
use std::time::{Duration, Instant};
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);
});
let now = Instant::now();
assert_eq!(
s.send_deadline(1, now + Duration::from_millis(500)),
Err(SendTimeoutError::Timeout(1)),
);
assert_eq!(
s.send_deadline(2, now + Duration::from_millis(1500)),
Ok(()),
);
assert_eq!(
s.send_deadline(3, now + Duration::from_millis(2000)),
Err(SendTimeoutError::Disconnected(3)),
);
pub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true
if the channel is empty.
Note: Zero-capacity channels are always empty.
Examples
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
assert!(s.is_empty());
s.send(0).unwrap();
assert!(!s.is_empty());
pub fn is_full(&self) -> bool
pub fn is_full(&self) -> bool
Returns true
if the channel is full.
Note: Zero-capacity channels are always full.
Examples
use crossbeam_channel::bounded;
let (s, r) = bounded(1);
assert!(!s.is_full());
s.send(0).unwrap();
assert!(s.is_full());
pub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of messages in the channel.
Examples
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);
pub fn capacity(&self) -> Option<usize>
pub fn capacity(&self) -> Option<usize>
If the channel is bounded, returns its capacity.
Examples
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));
pub fn same_channel(&self, other: &Sender<T>) -> bool
pub fn same_channel(&self, other: &Sender<T>) -> bool
Returns true
if senders belong to the same channel.
Examples
use crossbeam_channel::unbounded;
let (s, _) = unbounded::<usize>();
let s2 = s.clone();
assert!(s.same_channel(&s2));
let (s3, _) = unbounded();
assert!(!s.same_channel(&s3));
Trait Implementations
impl<T> RefUnwindSafe for Sender<T>
impl<T> Send for Sender<T>where
T: Send,
impl<T> Sync for Sender<T>where
T: Send,
impl<T> UnwindSafe for Sender<T>
Auto Trait Implementations
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist. Read moresourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moresourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read morefn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.