Struct juggle::Yield

pub struct Yield(_);

Helper struct for dealing with task switching.

Implementations

impl Yield

pub fn once() -> Self

When awaited yields this task once. Causes task switch.

For more convenient method of switching tasks see yield_once!() macro.

When resulting Future is polled, for the first time it notifies the waker and returns Poll::Pending, second and all other polls return Poll::Ready(()).

pub fn none() -> Self

When awaited it won't cause task switch.

Future returned by this method when polled always return Poll::Ready(()).

pub fn times(remaining: usize) -> YieldTimes

When awaited yields this task specific number of times.

Resulting Future notifies the waker and returns Poll::Pending 'remaining' number of times, all other polls return Poll::Ready(()).

pub fn yield_while<F>(predicate: F) -> YieldWhile<F> where
    F: FnMut() -> bool, 

When awaited yields this task until provided closure returns false.

Note that when first call on closure returns false, this task will not be yielded. This method is usefull when we want to do busy wait but also leave cpu time for other tasks.

Examples

let interrupt_flag: &AtomicBool = //...

Yield::yield_while(||!interrupt_flag.load(Ordering::Acquire)).await;

Trait Implementations

impl Clone for Yield

fn clone(&self) -> Yield

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Yield

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

Formats the value using the given formatter.

impl Eq for Yield

impl Future for Yield

type Output = ()

The type of value produced on completion.

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

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

impl Hash for Yield

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Yield> for Yield

fn eq(&self, other: &Yield) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Yield) -> bool

This method tests for !=.

impl StructuralEq for Yield

impl StructuralPartialEq for Yield