Struct std::task::Waker
#[repr(transparent)]pub struct Waker { /* fields omitted */ }
A Waker
is a handle for waking up a task by notifying its executor that it is ready to be run.
This handle encapsulates a RawWaker
instance, which defines the executor-specific wakeup behavior.
Implements Clone
, Send
, and Sync
.
Implementations
impl Waker
pub fn wake(self)
Wake up the task associated with this Waker
.
pub fn wake_by_ref(&self)
Wake up the task associated with this Waker
without consuming the Waker
.
This is similar to wake
, but may be slightly less efficient in the case where an owned Waker
is available. This method should be preferred to calling waker.clone().wake()
.
pub fn will_wake(&self, other: &Waker) -> bool
Returns true
if this Waker
and another Waker
have awoken the same task.
This function works on a best-effort basis, and may return false even when the Waker
s would awaken the same task. However, if this function returns true
, it is guaranteed that the Waker
s will awaken the same task.
This function is primarily used for optimization purposes.
pub unsafe fn from_raw(waker: RawWaker) -> Waker
Creates a new Waker
from RawWaker
.
The behavior of the returned Waker
is undefined if the contract defined in RawWaker
’s and RawWakerVTable
’s documentation is not upheld. Therefore this method is unsafe.
Trait Implementations
impl Clone for Waker
pub fn clone(&self) -> Waker
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for Waker
pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl Drop for Waker
pub fn from(waker: Arc<W>) -> Waker
Use a Wake
-able type as a Waker
.
No heap allocations or atomic operations are used for this conversion.
impl Send for Waker
impl Sync for Waker
impl Unpin for Waker
Auto Trait Implementations
impl RefUnwindSafe for Waker
impl UnwindSafe for Waker
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
#41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/task/struct.Waker.html