Struct AppQueue

pub struct AppQueue { /* private fields */ }

Implementations

impl AppQueue

Central queue interface

See the crate documentation to see how to use this crate.

pub async fn new(db_path: impl AsRef<Path>) -> Result<Arc<Self>>

Opens or creates a new queue.

Errors

This function returns an error if the database cannot be opened, such as when the database is inaccessible or corrupt.

pub async fn run_job_loop(self: Arc<Self>) -> Result<Never>

Uses the current task to serve as a job runner.

This future will never resolve, unless an error occurs.

pub fn run_job_workers(self: Arc<Self>, num_workers: usize)

Spawns a number of worker tasks for running jobs.

pub fn run_job_workers_default(self: Arc<Self>)

Spawns a default number of worker tasks for running jobs.

pub async fn add_unique_job( &self, id: impl AsRef<str>, job: Box<dyn Job>, ) -> Result<()>

Adds a job with a specific opaque ID to the queue.

This will not do anything if the job is already in the queue.

pub async fn add_job(&self, job: Box<dyn Job>) -> Result<()>

Adds a job to the queue.

unlike [add_unique_job], this will use a random ID.