Skip to main content

mytheclipse_queue/
lib.rs

1//! # mytheclipse-queue
2//!
3//! A job queue abstraction so your background work isn't locked to one
4//! transport. Provides a single [`Queue`] trait, [`Job`] type, and `WorkerPool`
5//! executor with configurable retry/backoff, concurrency, and a dead-letter
6//! queue.
7//!
8//! The backend that ships is in-memory (`InMemoryQueue`, feature `in-memory`):
9//! one `Mutex<Vec<Job>>` + `Notify` per topic, no external service. `Queue` is a
10//! trait, so another transport can implement it without touching `WorkerPool`.
11
12#![deny(missing_docs)]
13pub mod error;
14#[cfg(feature = "in-memory")]
15mod host;
16#[cfg(feature = "in-memory")]
17pub mod in_memory;
18pub mod job;
19pub mod traits;
20#[cfg(feature = "in-memory")]
21pub mod worker;
22
23pub use error::{JobError, QueueError};
24#[cfg(feature = "in-memory")]
25pub use in_memory::InMemoryQueue;
26pub use job::{Job, JobId};
27pub use traits::Queue;
28#[cfg(feature = "in-memory")]
29pub use worker::{JobFuture, JobHandler, WorkerConfig, WorkerPool};
30
31#[cfg(feature = "in-memory")]
32pub mod backpressure_enqueue;
33#[cfg(feature = "in-memory")]
34pub mod batch;
35#[cfg(feature = "in-memory")]
36pub mod rate_limited;
37#[cfg(feature = "in-memory")]
38pub mod worker_rate_limited;
39#[cfg(feature = "in-memory")]
40pub use backpressure_enqueue::{
41    enqueue_with_backpressure, BackpressureEnforcer, BackpressureError,
42};
43#[cfg(feature = "in-memory")]
44pub use rate_limited::{RateLimitQueueError, RateLimitedQueue};
45#[cfg(feature = "in-memory")]
46pub use worker_rate_limited::RateLimitedWorkerPool;
47
48#[cfg(feature = "in-memory")]
49pub mod pipeline;
50#[cfg(feature = "in-memory")]
51pub use pipeline::{Stage, StageError, StageRunner};
52
53/// The common case, in one import.
54///
55/// ```
56/// use mytheclipse_queue::prelude::*;
57/// ```
58///
59/// [`Queue`] and [`JobHandler`] are the reason this exists: `enqueue` and
60/// `handle` are trait methods, so they are not callable until the traits are in
61/// scope.
62pub mod prelude {
63    pub use crate::{Job, JobError, JobFuture, JobHandler, Queue, QueueError};
64
65    #[cfg(feature = "in-memory")]
66    pub use crate::{InMemoryQueue, WorkerPool};
67}