Struct phron_finality::sync::task_queue::TaskQueue

pub struct TaskQueue<T> {
    queue: BinaryHeap<ScheduledTask<T>>,
}

Fields

queue: BinaryHeap<ScheduledTask<T>>

Implementations

impl<T> TaskQueue<T>

Implements a queue allowing for scheduling tasks for some time in the future.

Does not actually execute any tasks, is used for ordering in time only.

pub fn new() -> Self

Creates an empty queue.

pub fn schedule_in(&mut self, task: T, delay: Duration)

Schedules task for after delay.

pub async fn pop(&mut self) -> Option<T>

Awaits for the first and most overdue task and returns it. Returns None if there are no tasks.

Cancel safety

This method is cancellation safe. If you use it as the event in a tokio::select! statement and some other branch completes first, then it is guaranteed that the TaskQueue state will be unchanged.

async fn sleep_until_the_next_task_is_ready(&self)

Sleeps until some task is ready to be executed, or returns immediately if there are no tasks. Cancellation safe, since doesn’t mutate &self.

Trait Implementations

impl<T: Clone> Clone for TaskQueue<T>

fn clone(&self) -> TaskQueue<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TaskQueue<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TaskQueue<T>

fn default() -> TaskQueue<T>

Returns the “default value” for a type.