[−][src]Struct futures_util::task::LocalWakerRef
A LocalWaker that is only valid for a given lifetime.
Note: this type implements Deref<Target = LocalWaker>,
so it can be used to get a &LocalWaker.
Methods
impl<'a> LocalWakerRef<'a>[src]
impl<'a> LocalWakerRef<'a>pub fn new(local_waker: LocalWaker) -> Self[src]
pub fn new(local_waker: LocalWaker) -> SelfCreate a new LocalWakerRef from a LocalWaker.
Note: this function is safe, but it is generally only used
from unsafe contexts that need to create a LocalWaker
that is guaranteed not to outlive a particular lifetime.
Methods from Deref<Target = LocalWaker>
pub fn as_waker(&self) -> &Waker[src]
pub fn as_waker(&self) -> &Waker🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
Borrows this LocalWaker as a Waker.
Waker is nearly identical to LocalWaker, but is threadsafe
(implements Send and Sync).
pub fn wake(&self)[src]
pub fn wake(&self)🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
Wake up the task associated with this LocalWaker.
pub fn will_wake(&self, other: &LocalWaker) -> bool[src]
pub fn will_wake(&self, other: &LocalWaker) -> bool🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
Returns whether or not this LocalWaker and other LocalWaker awaken the same task.
This function works on a best-effort basis, and may return false even
when the LocalWakers would awaken the same task. However, if this function
returns true, it is guaranteed that the LocalWakers will awaken the same
task.
This function is primarily used for optimization purposes.
pub fn will_wake_nonlocal(&self, other: &Waker) -> bool[src]
pub fn will_wake_nonlocal(&self, other: &Waker) -> bool🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
Returns whether or not this LocalWaker and other Waker awaken the same task.
This function works on a best-effort basis, and may return false even
when the Wakers would awaken the same task. However, if this function
returns true, it is guaranteed that the LocalWakers will awaken the same
task.
This function is primarily used for optimization purposes.
Trait Implementations
impl<'a> Deref for LocalWakerRef<'a>[src]
impl<'a> Deref for LocalWakerRef<'a>type Target = LocalWaker
The resulting type after dereferencing.
fn deref(&self) -> &LocalWaker[src]
fn deref(&self) -> &LocalWakerDereferences the value.
impl<'a> Debug for LocalWakerRef<'a>[src]
impl<'a> Debug for LocalWakerRef<'a>Auto Trait Implementations
impl<'a> Send for LocalWakerRef<'a>
impl<'a> Send for LocalWakerRef<'a>impl<'a> Sync for LocalWakerRef<'a>
impl<'a> Sync for LocalWakerRef<'a>Blanket Implementations
impl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> From for T[src]
impl<T> From for Timpl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>try_from)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, ⓘImportant traits for &'_ mut Ifn borrow(&self) -> &T[src]
fn borrow(&self) -> &TImmutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeId🔬 This is a nightly-only experimental API. (get_type_id)
this method will likely be replaced by an associated static
Gets the TypeId of self. Read more
impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, ⓘImportant traits for &'_ mut Ifn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>,