Struct dbq::Queue

pub struct Queue { /* fields omitted */ }

Represents a job queue stored in the database. Because the queue is stored in the database, the queue should be considered to have internal mutability

Examples

use dbq::{Queue, SchemaConfig};
use postgres::{Connection, TlsMode};
use serde_json::value::Value;

let q = Queue::new(SchemaConfig::default(), "de_lancie_q".to_string());

let conn = Connection::connect("postgres://user@localhost".to_string(), TlsMode::None)
    .unwrap();
q.enqueue("send_email", Value::String("example@example.com".to_string()), 3, &conn);
q.enqueue("send_sms", Value::String("+1-555-555-5555".to_string()), 3, &conn);

Methods

impl Queue

pub fn new(schema_config: SchemaConfig, name: String) -> Queue

pub fn enqueue<A: Serialize, C: GenericConnection>(
    &self,
    class: &str,
    args: A,
    max_attempts: u32,
    conn: &C
) -> Result<u64>

Add a new job to the queue

pub fn len<C: GenericConnection>(&self, conn: &C) -> Result<usize>

Length of the queue

pub fn lookup_in_queue<C: GenericConnection>(
    &self,
    job_id: u64,
    conn: &C
) -> Result<Option<Job>>

Find a job in the queue by its job ID

pub fn lookup_in_dead_letters<C: GenericConnection>(
    &self,
    job_id: u64,
    conn: &C
) -> Result<Option<Job>>

Find a job in the queue's "dead letter" storage by its job ID

pub fn clear<C: GenericConnection>(&self, conn: &C) -> Result<()>

Delete all jobs from the queue. Calling this function may block until all running jobs in the queue finish

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Queue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Queue

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

Formats the value using the given formatter.