Struct SqliteQueue

pub struct SqliteQueue { /* private fields */ }

An implementation of the Queue backed by SQlite

Implementations

impl SqliteQueue

pub fn with_pool(pool: SqlitePool) -> Self

Trait Implementations

impl Clone for SqliteQueue

fn clone(&self) -> SqliteQueue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Queue for SqliteQueue

type JobHandle = SqliteJobHandle

fn schedule_at<'life0, 'async_trait, J>( &'life0 self, payload: J::Payload, scheduled_at: DateTime, priority: i8, ) -> Pin<Box<dyn Future<Output = Result<Xid, QueueError>> + Send + 'async_trait>>

where J: JobProcessor + 'static + 'async_trait, J::Payload: Encode, Self: 'async_trait, 'life0: 'async_trait,

Schedule a job to run at the future time.

fn poll_next_with_instant<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, job_types: &'life1 [&'life2 str], now: DateTime, ) -> Pin<Box<dyn Future<Output = Result<Option<SqliteJobHandle>, QueueError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Pool queue, implementation should not wait for next job, if there nothing return Ok(None).

fn cancel_job<'life0, 'async_trait>( &'life0 self, job_id: Xid, ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Cancel job that has been scheduled. Right now this will only cancel if the job hasn’t started yet.

fn unschedule_job<'life0, 'async_trait, J>( &'life0 self, job_id: Xid, ) -> Pin<Box<dyn Future<Output = Result<J::Payload, QueueError>> + Send + 'async_trait>>

where J: JobProcessor + 'static + 'async_trait, J::Payload: Decode, Self: 'async_trait, 'life0: 'async_trait,

The same as cancel_job, but returns payload of canceled job. If deserialization fails, then job won’t be cancelled.

fn schedule<'life0, 'async_trait, J>( &'life0 self, payload: <J as JobProcessor>::Payload, priority: i8, ) -> Pin<Box<dyn Future<Output = Result<Id, QueueError>> + Send + 'async_trait>>

where 'life0: 'async_trait, J: JobProcessor + 'static + 'async_trait, <J as JobProcessor>::Payload: Encode, Self: 'async_trait,

Schedule a job to run next. Depending on queue backlog this may start running later than you expect.

fn schedule_in<'life0, 'async_trait, J>( &'life0 self, payload: <J as JobProcessor>::Payload, scheduled_in: TimeDelta, priority: i8, ) -> Pin<Box<dyn Future<Output = Result<Id, QueueError>> + Send + 'async_trait>>

where 'life0: 'async_trait, J: JobProcessor + 'static + 'async_trait, <J as JobProcessor>::Payload: Encode, Self: 'async_trait,

Schedule a job to run at the future time relative to now.

fn poll_next<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, job_types: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<Option<Self::JobHandle>, QueueError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Pool queue, implementation should not wait for next job, if there nothing return Ok(None).

fn next<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, job_types: &'life1 [&'life2 str], interval: TimeDelta, ) -> Pin<Box<dyn Future<Output = Result<Self::JobHandle, QueueError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Await next job. Default implementation polls the queue with defined interval until there is something.