awa_model/
lib.rs

1pub mod adapter;
2pub mod admin;
3pub mod batch_operations;
4pub mod bridge;
5pub mod callback_contract;
6pub mod cron;
7pub mod dlq;
8pub mod error;
9pub mod insert;
10pub mod job;
11pub mod kind;
12pub mod migrations;
13pub mod partitioned_queue;
14pub mod queue_storage;
15pub mod storage;
16pub mod unique;
17
18// Re-exports for ergonomics
19pub use adapter::postgres::{prepare_job_insert, prepare_raw_job_insert, PreparedJobInsert};
20pub use admin::{
21    CallbackConfig, DefaultAction, JobKindDescriptor, JobKindOverview, ListJobsFilter,
22    QueueDescriptor, QueueOverview, QueueRuntimeConfigSnapshot, QueueRuntimeMode,
23    QueueRuntimeSnapshot, QueueRuntimeSummary, RateLimitSnapshot, ResolveOutcome,
24    RetryFailedOutcome, RuntimeInstance, RuntimeOverview, RuntimeSnapshotInput,
25    StateTimeseriesBucket, StorageCapability,
26};
27pub use batch_operations::{
28    BatchOperation, BatchOperationFilter, BatchOperationKind, BatchOperationPreview,
29    BatchOperationSpec, BatchOperationState, ListBatchOperationsFilter, SubmitBatchOperation,
30};
31
32/// Deprecated alias preserved for one release so existing downstream code
33/// compiling against `awa_model::QueueStats` keeps building. New callers
34/// should use [`QueueOverview`] directly — the renamed type carries
35/// additional descriptor fields this alias predates.
36#[deprecated(since = "0.5.4", note = "use `QueueOverview` instead")]
37pub type QueueStats = QueueOverview;
38pub use cron::{CronJobRow, CronMissedFirePolicy, PeriodicJob, PeriodicJobBuilder};
39pub use dlq::{DlqMetadata, DlqRow, ListDlqFilter, RetryFromDlqOpts};
40pub use error::{map_sqlx_error, AwaError};
41pub use insert::{insert, insert_many, insert_many_copy, insert_many_copy_from_pool, insert_with};
42pub use job::{InsertOpts, InsertParams, JobRow, JobState, UniqueOpts};
43pub use partitioned_queue::{
44    partition_for_ordering_key, partition_hash64, PartitionedQueue, PartitionedQueueError,
45};
46pub use queue_storage::{
47    ClaimedEntry, ClaimedRuntimeJob, PruneOutcome, QueueCounts, QueueStorage, QueueStorageConfig,
48    RotateOutcome, SkipReason, TerminalDeltaRollupOutcome,
49};
50pub use storage::StorageStatus;
51
52// Re-export the derive macro
53pub use awa_macros::JobArgs;
54
55/// Trait for typed job arguments.
56///
57/// Implement this trait (or use `#[derive(JobArgs)]`) to define a job type.
58/// The `kind()` method returns the snake_case kind string that identifies
59/// this job type across languages.
60pub trait JobArgs: serde::Serialize {
61    /// The kind string for this job type (e.g., "send_email").
62    fn kind() -> &'static str
63    where
64        Self: Sized;
65
66    /// Get the kind string for an instance.
67    fn kind_str(&self) -> &'static str
68    where
69        Self: Sized,
70    {
71        Self::kind()
72    }
73
74    /// Serialize to JSON value.
75    fn to_args(&self) -> Result<serde_json::Value, serde_json::Error> {
76        serde_json::to_value(self)
77    }
78}
awa_model/lib.rs

awa_model/
lib.rs
