Struct NeedsYield

pub struct NeedsYield { /* private fields */ }

An object that can be polled to see if a yield has been requested.

Implementations

impl NeedsYield

pub fn new() -> Self

Creates a new object.

pub fn request_yield(&self) -> bool

Requests a yield.

Returns whether a signal is necessary to ensure that the task yields soon.

pub async fn maybe_yield(&self)

Yields execution to the executor if request_yield has been called since the last call to maybe_yield.

Trait Implementations

impl Debug for NeedsYield

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

Formats the value using the given formatter.