Struct heron::rapier_plugin::rapier2d::crossbeam::channel::Receiver [−]
pub struct Receiver<T> { /* fields omitted */ }
Expand description
The receiving side of a channel.
Examples
use std::thread;
use std::time::Duration;
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
thread::spawn(move || {
let _ = s.send(1);
thread::sleep(Duration::from_secs(1));
let _ = s.send(2);
});
assert_eq!(r.recv(), Ok(1)); // Received immediately.
assert_eq!(r.recv(), Ok(2)); // Received after 1 second.
Implementations
impl<T> Receiver<T>
impl<T> Receiver<T>
pub fn try_recv(&self) -> Result<T, TryRecvError>
pub fn try_recv(&self) -> Result<T, TryRecvError>
Attempts to receive a message from the channel without blocking.
This method will either receive a message from the channel immediately or return an error if the channel is empty.
If called on a zero-capacity channel, this method will receive a message only if there happens to be a send operation on the other side of the channel at the same time.
Examples
use crossbeam_channel::{unbounded, TryRecvError};
let (s, r) = unbounded();
assert_eq!(r.try_recv(), Err(TryRecvError::Empty));
s.send(5).unwrap();
drop(s);
assert_eq!(r.try_recv(), Ok(5));
assert_eq!(r.try_recv(), Err(TryRecvError::Disconnected));
Blocks the current thread until a message is received or the channel is empty and disconnected.
If the channel is empty and not disconnected, this call will block until the receive operation can proceed. If the channel is empty and becomes disconnected, this call will wake up and return an error.
If called on a zero-capacity channel, this method will wait for a send operation to appear on the other side of the channel.
Examples
use std::thread;
use std::time::Duration;
use crossbeam_channel::{unbounded, RecvError};
let (s, r) = unbounded();
thread::spawn(move || {
thread::sleep(Duration::from_secs(1));
s.send(5).unwrap();
drop(s);
});
assert_eq!(r.recv(), Ok(5));
assert_eq!(r.recv(), Err(RecvError));
pub fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError>
pub fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError>
Waits for a message to be received from the channel, but only for a limited time.
If the channel is empty and not disconnected, this call will block until the receive operation can proceed or the operation times out. If the channel is empty and becomes disconnected, this call will wake up and return an error.
If called on a zero-capacity channel, this method will wait for a send operation to appear on the other side of the channel.
Examples
use std::thread;
use std::time::Duration;
use crossbeam_channel::{unbounded, RecvTimeoutError};
let (s, r) = unbounded();
thread::spawn(move || {
thread::sleep(Duration::from_secs(1));
s.send(5).unwrap();
drop(s);
});
assert_eq!(
r.recv_timeout(Duration::from_millis(500)),
Err(RecvTimeoutError::Timeout),
);
assert_eq!(
r.recv_timeout(Duration::from_secs(1)),
Ok(5),
);
assert_eq!(
r.recv_timeout(Duration::from_secs(1)),
Err(RecvTimeoutError::Disconnected),
);
pub fn recv_deadline(&self, deadline: Instant) -> Result<T, RecvTimeoutError>
pub fn recv_deadline(&self, deadline: Instant) -> Result<T, RecvTimeoutError>
Waits for a message to be received from the channel, but only before a given deadline.
If the channel is empty and not disconnected, this call will block until the receive operation can proceed or the operation times out. If the channel is empty and becomes disconnected, this call will wake up and return an error.
If called on a zero-capacity channel, this method will wait for a send operation to appear on the other side of the channel.
Examples
use std::thread;
use std::time::{Instant, Duration};
use crossbeam_channel::{unbounded, RecvTimeoutError};
let (s, r) = unbounded();
thread::spawn(move || {
thread::sleep(Duration::from_secs(1));
s.send(5).unwrap();
drop(s);
});
let now = Instant::now();
assert_eq!(
r.recv_deadline(now + Duration::from_millis(500)),
Err(RecvTimeoutError::Timeout),
);
assert_eq!(
r.recv_deadline(now + Duration::from_millis(1500)),
Ok(5),
);
assert_eq!(
r.recv_deadline(now + Duration::from_secs(5)),
Err(RecvTimeoutError::Disconnected),
);
Returns true
if the channel is empty.
Note: Zero-capacity channels are always empty.
Examples
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
assert!(r.is_empty());
s.send(0).unwrap();
assert!(!r.is_empty());
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!(!r.is_full());
s.send(0).unwrap();
assert!(r.is_full());
Returns the number of messages in the channel.
Examples
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
assert_eq!(r.len(), 0);
s.send(1).unwrap();
s.send(2).unwrap();
assert_eq!(r.len(), 2);
If the channel is bounded, returns its capacity.
Examples
use crossbeam_channel::{bounded, unbounded};
let (_, r) = unbounded::<i32>();
assert_eq!(r.capacity(), None);
let (_, r) = bounded::<i32>(5);
assert_eq!(r.capacity(), Some(5));
let (_, r) = bounded::<i32>(0);
assert_eq!(r.capacity(), Some(0));
A blocking iterator over messages in the channel.
Each call to next
blocks waiting for the next message and then returns it. However, if
the channel becomes empty and disconnected, it returns None
without blocking.
Examples
use std::thread;
use crossbeam_channel::unbounded;
let (s, r) = unbounded();
thread::spawn(move || {
s.send(1).unwrap();
s.send(2).unwrap();
s.send(3).unwrap();
drop(s); // Disconnect the channel.
});
// Collect all messages from the channel.
// Note that the call to `collect` blocks until the sender is dropped.
let v: Vec<_> = r.iter().collect();
assert_eq!(v, [1, 2, 3]);
A non-blocking iterator over messages in the channel.
Each call to next
returns a message if there is one ready to be received. The iterator
never blocks waiting for the next message.
Examples
use std::thread;
use std::time::Duration;
use crossbeam_channel::unbounded;
let (s, r) = unbounded::<i32>();
thread::spawn(move || {
s.send(1).unwrap();
thread::sleep(Duration::from_secs(1));
s.send(2).unwrap();
thread::sleep(Duration::from_secs(2));
s.send(3).unwrap();
});
thread::sleep(Duration::from_secs(2));
// Collect all messages from the channel without blocking.
// The third message hasn't been sent yet so we'll collect only the first two.
let v: Vec<_> = r.try_iter().collect();
assert_eq!(v, [1, 2]);
pub fn same_channel(&self, other: &Receiver<T>) -> bool
pub fn same_channel(&self, other: &Receiver<T>) -> bool
Returns true
if receivers belong to the same channel.
Examples
use crossbeam_channel::unbounded;
let (_, r) = unbounded::<usize>();
let r2 = r.clone();
assert!(r.same_channel(&r2));
let (_, r3) = unbounded();
assert!(!r.same_channel(&r3));
Trait Implementations
impl<'a, T> IntoIterator for &'a Receiver<T>
impl<'a, T> IntoIterator for &'a Receiver<T>
impl<T> IntoIterator for Receiver<T>
impl<T> IntoIterator for Receiver<T>
impl<T> RefUnwindSafe for Receiver<T>
impl<T> UnwindSafe for Receiver<T>
Auto Trait Implementations
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert 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 more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more