Struct Notified 

pub struct Notified<'a> { /* private fields */ }

The future Notify::notified returns.

It is fused: once it completes, polling it again is ready at once.

Dropping it after a notify_one or notify_last reached it, but before it completed, passes that notification to the next waiter.

Implementations

impl Notified<'_>

pub fn enable(self: Pin<&mut Self>) -> bool

Adds this future to the waiters that receive notify_one and notify_last, as its first poll would, without registering a waker. Polling does the same; this is for a caller that must be queued before it checks a condition, so a notification sent in between is not stored as a permit for someone else.

notify_waiters is received from creation on, enabled or not.

Returns true if the future is ready, which any later poll then reports at once. That is so when:

1. notify_waiters was called since the future was created;
2. this is the first enable or poll and the Notify held a permit, which the call consumes; or
3. the future was enabled or polled before and has since been notified.

use nuclei::sync::Notify;
use std::pin::pin;

let notify = Notify::new();
let mut waiting = pin!(notify.notified());
assert!(!waiting.as_mut().enable(), "nothing was sent yet");
notify.notify_one();
assert!(waiting.as_mut().enable(), "the one sent after enable is its");

Trait Implementations

impl Debug for Notified<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Notified<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Future for Notified<'_>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.