Struct StopTask 

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

A future indicating that the task should return for event processing or because the task was stopped.

See the worker cancellation guide.

Implementations

impl<'a> StopTask<'a>

pub async fn run_unstoppable<R>( f: impl AsyncFnOnce(&mut StopTask<'_>) -> R, ) -> R

Runs f with a task that never receives control requests.

Intended for test helpers that run a device without a TaskControl.

pub fn check(&self) -> Result<(), Cancelled>

Checks whether the task should return for stop or event processing.

Call at cancel-safe boundaries in loops that can keep making progress without yielding. This does not yield or cancel an outstanding wait; use Self::until_stopped for waits that must be interruptible.

This only performs a relaxed atomic load. Request producers publish the signal directly; checking does not register or poll a waker.

pub fn check_handle(&self) -> Result<StopCheck<'a>, Cancelled>

Checks for a request and returns a handle for this worker activation.

Use this inside a future passed to Self::until_stopped, or when several processing loops need to check the same control request.

pub async fn until_stopped<F: Future>( &mut self, fut: F, ) -> Result<F::Output, Cancelled>

Runs fut until the task is requested to stop.

If fut completes, then Ok(_) is returned.

If the task is requested to stop before fut completes, then fut is dropped and Err(Cancelled) is returned. Stop takes priority when both stop and work are ready.

Trait Implementations

impl Future for StopTask<'_>

type Output = ()

The type of value produced on completion.

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

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