Struct LowPriorityTask 

pub struct LowPriorityTask(/* private fields */);

LowPriorityTask is to be used for tasks that are low priority. Low priority tasks should periodically call wait_until_idle which will wait until no other normal priority tasks have been running for the specified tasks. A normal priority task is any task that isn’t a low priority one (due to creating an instance of LowPriorityTask).

Implementations

impl LowPriorityTask

pub fn new() -> Self

Marks the current task as a low priority task which means that it won’t count as activity that wait_until_idle will respect.

Panics

This will panic if there is no task currently running or if the task is already marked as a low priority task.

pub async fn wait_until_idle_for( &self, period: MonotonicDuration, deadline: MonotonicInstant, )

Waits until the executor has been idle for period i.e. no normal priority tasks have been polled for period. deadline is the limit for how long this will wait.

Trait Implementations

impl Default for LowPriorityTask

fn default() -> Self

See LowPriorityTask::new().

impl Drop for LowPriorityTask

fn drop(&mut self)

Executes the destructor for this type.