Add cautionary paragraph about noop wakers. · patricklam/verify-rust-std@0497f0c (original) (raw)

`@@ -539,6 +539,10 @@ impl Waker {

`

539

539

`/// some futures, but are not expecting those futures to wake the waker or

`

540

540

`/// do not need to do anything specific if it happens.

`

541

541

`///

`

``

542

`` +

/// More generally, using Waker::noop() to poll a future

``

``

543

`+

/// means discarding the notification of when the future should be polled again.

`

``

544

`+

/// So it should only be used when such a notification will not be needed to make progress.

`

``

545

`+

///

`

542

546

`` /// If an owned Waker is needed, clone() this one.

``

543

547

`///

`

544

548

`/// # Examples

`

`@@ -796,6 +800,10 @@ impl LocalWaker {

`

796

800

`/// some futures, but are not expecting those futures to wake the waker or

`

797

801

`/// do not need to do anything specific if it happens.

`

798

802

`///

`

``

803

`` +

/// More generally, using LocalWaker::noop() to poll a future

``

``

804

`+

/// means discarding the notification of when the future should be polled again,

`

``

805

`+

/// So it should only be used when such a notification will not be needed to make progress.

`

``

806

`+

///

`

799

807

`` /// If an owned LocalWaker is needed, clone() this one.

``

800

808

`///

`

801

809

`/// # Examples

`