Struct waker_generic::Blocker

pub struct Blocker { /* private fields */ }

A blocker that blocks in a loop until the associated waker is woken.

To obtain a Blocker and its associated core::task::Waker, call new_waker().

Implementations

impl Blocker

pub fn block<B, R>(&self, block_action: B)where B: Fn() -> R,

Performs the given block_action within this Blocker, looping until the associated waker is woken.

If the waker was already woken prior to this function being called, it will return immediately.

After this function returns, the inner state of the blocker+waker pair will have been reset to its initial “unwoken” state, enabling them to be re-used. In other words, this function can be called again, at which point it will block until the waker is woken again.

Arguments

• block_action: a closure that is called in a loop until its woker is woken. The return value R of the closure is any arbitrary value that will be held until after the blocker has released the lock on its inner state shared with the waker.
  • This can be used, for example, to yield the CPU to another task.