Struct FlashQ 

pub struct FlashQ { /* private fields */ }

flashQ client with connection pooling.

Implementations

impl FlashQ

pub fn new() -> Self

Create a new client with default options.

pub fn with_options(opts: ClientOptions) -> Self

Create a new client with custom options.

pub async fn connect(&self) -> Result<()>

Connect to the server.

pub async fn close(&self) -> Result<()>

Close all connections.

pub fn is_connected(&self) -> bool

Check if connected to the server.

pub fn pool_stats(&self) -> (u64, u64, usize)

Get pool statistics: (reconnects, failures, healthy_connections).

pub async fn auth(&self, token: &str) -> Result<bool>

Authenticate with the server.

pub async fn ping(&self) -> Result<bool>

Ping the server.

pub async fn push<T: Serialize>( &self, queue: &str, data: T, opts: Option<PushOptions>, ) -> Result<u64>

Push a job to a queue.

pub async fn push_batch( &self, queue: &str, jobs: Vec<JobPayload>, ) -> Result<BatchPushResult>

Push multiple jobs to a queue.

pub async fn pull( &self, queue: &str, timeout: Option<Duration>, ) -> Result<Option<Job>>

Pull a single job from a queue (blocking).

pub async fn pull_batch( &self, queue: &str, count: u32, timeout: Option<Duration>, ) -> Result<Vec<Job>>

Pull multiple jobs from a queue.

pub async fn ack(&self, job_id: u64, result: Option<Value>) -> Result<bool>

Acknowledge job completion with optional result.

pub async fn ack_batch(&self, job_ids: Vec<u64>) -> Result<u32>

Acknowledge multiple jobs.

pub async fn fail(&self, job_id: u64, error: Option<&str>) -> Result<bool>

Fail a job with optional error message.

impl FlashQ

Job query and management methods.

pub async fn get_job(&self, job_id: u64) -> Result<Option<JobWithState>>

Get a job by ID with its current state.

pub async fn get_state(&self, job_id: u64) -> Result<Option<JobState>>

Get job state only.

pub async fn get_result(&self, job_id: u64) -> Result<Option<Value>>

Get job result.

pub async fn get_job_by_custom_id( &self, custom_id: &str, ) -> Result<Option<JobWithState>>

Get job by custom ID (idempotency lookup).

pub async fn get_jobs_batch( &self, job_ids: Vec<u64>, ) -> Result<Vec<JobWithState>>

Get multiple jobs by IDs.

pub async fn get_jobs( &self, queue: Option<&str>, state: Option<JobState>, limit: Option<u32>, offset: Option<u32>, ) -> Result<JobsResult>

List jobs with filtering and pagination.

pub async fn get_job_counts(&self, queue: &str) -> Result<JobCounts>

Get job counts by state for a queue.

pub async fn count(&self, queue: &str) -> Result<u64>

Count waiting + delayed jobs in a queue.

pub async fn finished( &self, job_id: u64, timeout: Option<Duration>, ) -> Result<Option<Value>>

Wait for job completion and return result (blocking).

pub async fn cancel(&self, job_id: u64) -> Result<bool>

Cancel a pending job.

pub async fn progress( &self, job_id: u64, progress: u8, message: Option<&str>, ) -> Result<bool>

Update job progress (0-100) with optional message.

pub async fn get_progress(&self, job_id: u64) -> Result<ProgressInfo>

Get job progress.

pub async fn update<T: Serialize>(&self, job_id: u64, data: T) -> Result<bool>

Update job data.

pub async fn change_priority(&self, job_id: u64, priority: i32) -> Result<bool>

Change job priority.

pub async fn move_to_delayed(&self, job_id: u64, delay: u64) -> Result<bool>

Move active job back to delayed state.

pub async fn promote(&self, job_id: u64) -> Result<bool>

Promote delayed job to waiting.

pub async fn discard(&self, job_id: u64) -> Result<bool>

Discard a job (move to DLQ).

pub async fn heartbeat(&self, job_id: u64) -> Result<bool>

Send heartbeat for a long-running job.

pub async fn log( &self, job_id: u64, message: &str, level: Option<&str>, ) -> Result<bool>

Add a log entry to a job.

pub async fn get_logs(&self, job_id: u64) -> Result<Vec<LogEntry>>

Get job log entries.

pub async fn get_children(&self, job_id: u64) -> Result<Vec<u64>>

Get child job IDs for a parent job.

pub async fn partial( &self, job_id: u64, data: Value, index: Option<u32>, ) -> Result<bool>

Send partial result for streaming.

impl FlashQ

Queue management, DLQ, rate limiting, cron, flow, and monitoring methods.

pub async fn pause(&self, queue: &str) -> Result<bool>

Pause a queue.

pub async fn resume(&self, queue: &str) -> Result<bool>

Resume a paused queue.

pub async fn is_paused(&self, queue: &str) -> Result<bool>

Check if a queue is paused.

pub async fn drain(&self, queue: &str) -> Result<u64>

Drain all waiting jobs from a queue. Returns count of drained jobs.

pub async fn obliterate(&self, queue: &str) -> Result<bool>

Remove ALL data for a queue (jobs, DLQ, cron, etc.).

pub async fn clean( &self, queue: &str, grace: u64, state: &str, limit: Option<u32>, ) -> Result<u64>

Clean jobs older than grace period by state.

pub async fn list_queues(&self) -> Result<Vec<QueueInfo>>

List all queues.

pub async fn get_dlq(&self, queue: &str, count: Option<u32>) -> Result<Vec<Job>>

Get jobs from the dead letter queue.

pub async fn retry_dlq(&self, queue: &str, job_id: Option<u64>) -> Result<u64>

Retry DLQ jobs. If job_id provided, retries specific job; otherwise retries all.

pub async fn purge_dlq(&self, queue: &str) -> Result<u64>

Purge all jobs from dead letter queue.

pub async fn set_rate_limit(&self, queue: &str, limit: u32) -> Result<bool>

Set rate limit for a queue (jobs per second).

pub async fn clear_rate_limit(&self, queue: &str) -> Result<bool>

Clear rate limit for a queue.

pub async fn set_concurrency(&self, queue: &str, limit: u32) -> Result<bool>

Set concurrency limit for a queue.

pub async fn clear_concurrency(&self, queue: &str) -> Result<bool>

Clear concurrency limit for a queue.

pub async fn add_cron(&self, name: &str, opts: CronOptions) -> Result<bool>

Add a cron job.

pub async fn delete_cron(&self, name: &str) -> Result<bool>

Delete a cron job.

pub async fn list_crons(&self) -> Result<Vec<CronJob>>

List all cron jobs.

pub async fn push_flow<T: Serialize>( &self, queue: &str, data: T, children: Vec<FlowChild>, opts: Option<PushOptions>, ) -> Result<FlowResult>

Push a flow (parent job with children dependencies).

pub async fn stats(&self) -> Result<Stats>

Get queue statistics.

pub async fn metrics(&self) -> Result<Metrics>

Get detailed metrics.

Trait Implementations

impl Default for FlashQ

fn default() -> Self

Returns the “default value” for a type.

impl Drop for FlashQ

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.