Struct ntex::task::LocalWaker [−][src]
pub struct LocalWaker { /* fields omitted */ }
Expand description
A synchronization primitive for task wakeup.
Sometimes the task interested in a given event will change over time.
An LocalWaker
can coordinate concurrent notifications with the consumer
potentially “updating” the underlying task to wake up. This is useful in
scenarios where a computation completes in another task and wants to
notify the consumer, but the consumer is in the process of being migrated to
a new logical task.
Consumers should call register
before checking the result of a computation
and producers should call wake
after producing the computation (this
differs from the usual thread::park
pattern). It is also permitted for
wake
to be called before register
. This results in a no-op.
A single LocalWaker
may be reused for any number of calls to register
or
wake
.
Implementations
impl LocalWaker
[src]
impl LocalWaker
[src]pub fn new() -> LocalWaker
[src]
pub fn new() -> LocalWaker
[src]Create an LocalWaker
.
pub fn register(&self, waker: &Waker) -> bool
[src]
pub fn register(&self, waker: &Waker) -> bool
[src]Registers the waker to be notified on calls to wake
.
Returns true
if waker was registered before.
Trait Implementations
impl Debug for LocalWaker
[src]
impl Debug for LocalWaker
[src]impl Default for LocalWaker
[src]
impl Default for LocalWaker
[src]pub fn default() -> LocalWaker
[src]
pub fn default() -> LocalWaker
[src]Returns the “default value” for a type. Read more
Auto Trait Implementations
impl !RefUnwindSafe for LocalWaker
impl !Send for LocalWaker
impl !Sync for LocalWaker
impl Unpin for LocalWaker
impl UnwindSafe for LocalWaker
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self