pub struct Parker { /* fields omitted */ }
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. It may also return spuriously, without
consuming the token.
-
The park_timeout
method works the same as park
, but blocks 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 by park
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
.
use std::thread;
use std::time::Duration;
use crossbeam_utils::sync::Parker;
let mut p = Parker::new();
let u = p.unparker().clone();
u.unpark();
p.park();
thread::spawn(move || {
thread::sleep(Duration::from_millis(500));
u.unpark();
});
p.park();
Creates a new Parker
.
use crossbeam_utils::sync::Parker;
let p = Parker::new();
Blocks the current thread until the token is made available.
A call to park
may wake up spuriously without consuming the token, and callers should be
prepared for this possibility.
use crossbeam_utils::sync::Parker;
let mut p = Parker::new();
let u = p.unparker().clone();
u.unpark();
p.park();
Blocks the current thread until the token is made available, but only for a limited time.
A call to park_timeout
may wake up spuriously without consuming the token, and callers
should be prepared for this possibility.
use std::time::Duration;
use crossbeam_utils::sync::Parker;
let mut p = Parker::new();
p.park_timeout(Duration::from_millis(500));
Returns a reference to an associated Unparker
.
The returned Unparker
doesn't have to be used by reference - it can also be cloned.
use crossbeam_utils::sync::Parker;
let mut p = Parker::new();
let u = p.unparker().clone();
u.unpark();
p.park();
Formats the value using the given formatter. 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
type Error = <U as TryFrom<T>>::Error
🔬 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