Struct heron::rapier_plugin::rapier2d::crossbeam::sync::Parker [−]
pub struct Parker { /* fields omitted */ }
Expand description
A thread parking primitive.
Conceptually, each Parker
has an associated token which is initially not present:
-
The
park
method blocks the current thread unless or until the token is available, at which point it automatically consumes the token. -
The
park_timeout
andpark_deadline
methods work the same aspark
, but block for a specified maximum time. -
The
unpark
method atomically makes the token available if it wasn’t already. Because the token is initially absent,unpark
followed bypark
will result in the second call returning immediately.
In other words, each Parker
acts a bit like a spinlock that can be locked and unlocked using
park
and unpark
.
Examples
use std::thread;
use std::time::Duration;
use crossbeam_utils::sync::Parker;
let p = Parker::new();
let u = p.unparker().clone();
// Make the token available.
u.unpark();
// Wakes up immediately and consumes the token.
p.park();
thread::spawn(move || {
thread::sleep(Duration::from_millis(500));
u.unpark();
});
// Wakes up when `u.unpark()` provides the token.
p.park();
Implementations
impl Parker
impl Parker
pub fn park(&self)
pub fn park(&self)
Blocks the current thread until the token is made available.
Examples
use crossbeam_utils::sync::Parker;
let p = Parker::new();
let u = p.unparker().clone();
// Make the token available.
u.unpark();
// Wakes up immediately and consumes the token.
p.park();
pub fn park_timeout(&self, timeout: Duration)
pub fn park_timeout(&self, timeout: Duration)
Blocks the current thread until the token is made available, but only for a limited time.
Examples
use std::time::Duration;
use crossbeam_utils::sync::Parker;
let p = Parker::new();
// Waits for the token to become available, but will not wait longer than 500 ms.
p.park_timeout(Duration::from_millis(500));
pub fn park_deadline(&self, deadline: Instant)
pub fn park_deadline(&self, deadline: Instant)
Blocks the current thread until the token is made available, or until a certain deadline.
Examples
use std::time::{Duration, Instant};
use crossbeam_utils::sync::Parker;
let p = Parker::new();
let deadline = Instant::now() + Duration::from_millis(500);
// Waits for the token to become available, but will not wait longer than 500 ms.
p.park_deadline(deadline);
Returns a reference to an associated Unparker
.
The returned Unparker
doesn’t have to be used by reference - it can also be cloned.
Examples
use crossbeam_utils::sync::Parker;
let p = Parker::new();
let u = p.unparker().clone();
// Make the token available.
u.unpark();
// Wakes up immediately and consumes the token.
p.park();
Converts a Parker
into a raw pointer.
Examples
use crossbeam_utils::sync::Parker;
let p = Parker::new();
let raw = Parker::into_raw(p);
Converts a raw pointer into a Parker
.
Safety
This method is safe to use only with pointers returned by Parker::into_raw
.
Examples
use crossbeam_utils::sync::Parker;
let p = Parker::new();
let raw = Parker::into_raw(p);
let p = unsafe { Parker::from_raw(raw) };
Trait Implementations
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> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given [World]
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 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