Enum Error 

#[non_exhaustive]
pub enum Error {
    Database {
        operation: Cow<'static, str>,
        source: Error,
    },
    Pool(PoolError),
    Blocking(BoxDynError),
    Migration(BoxDynError),
    Row(BoxDynError),
    InvalidArgument(String),
    IdempotencyConflict {
        job_type: String,
        conflicting_keys: Vec<String>,
        total: usize,
    },
    Decode(BoxDynError),
    Json(Error),
    MissingField(&'static str),
    AlreadyRegistered(String),
    TaskNotFound {
        operation: Cow<'static, str>,
        task_id: String,
        queue: String,
        hint: &'static str,
    },
    StaleAcknowledgement {
        task_id: String,
        queue: String,
        worker_id: String,
    },
    WorkerNotRegistered {
        operation: Cow<'static, str>,
        worker_id: String,
        queue: String,
        hint: &'static str,
    },
    NotifyListener(String),
    SinkBufferFull(usize),
}

Error type returned by the Diesel PostgreSQL backend.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Database

Diesel query failed while running a named backend operation.

Fields

operation: Cow<'static, str>

Backend operation that was running when Diesel returned the error.

source: Error

Original Diesel error.

Pool(PoolError)

Acquiring a pooled connection failed.

Blocking(BoxDynError)

A blocking runtime task failed to complete.

Migration(BoxDynError)

Database migrations failed.

Row(BoxDynError)

A task row could not be converted into an Apalis task.

InvalidArgument(String)

A caller-supplied argument was out of range for the backend.

IdempotencyConflict

One or more tasks in an enqueue batch collided with the (job_type, idempotency_key) unique constraint.

The whole batch is rolled back, not only the colliding rows: the duplicates are dropped by ON CONFLICT DO NOTHING, then the post-insert check rolls the batch’s SAVEPOINT back, so every task in the batch is undone — including the non-conflicting ones. A surrounding (outer) transaction stays alive, so the caller can decide whether to commit the rest of its work or roll back. conflicting_keys lists exactly which idempotency_keys collided, so a batch caller can drop them and re-enqueue the rest. Match this variant instead of the Error::InvalidArgument message text to tell a benign duplicate apart from a real failure.

Fields

job_type: String

Queue (job_type) the conflicting batch targeted.

conflicting_keys: Vec<String>

The distinct idempotency_keys that collided — either against an already-stored row or another task in the same batch.

total: usize

Total tasks in the batch; all of them were rolled back.

Decode(BoxDynError)

A task payload or task result could not be decoded.

Json(Error)

JSON encoding or decoding failed.

MissingField(&'static str)

A required task field was missing.

AlreadyRegistered(String)

A worker or queue registration already exists.

TaskNotFound

A task could not be locked because it was absent or not currently lockable.

Fields

operation: Cow<'static, str>

Backend operation that failed.

task_id: String

Task id involved in the operation.

queue: String

Queue involved in the operation, or a placeholder when unconstrained.

hint: &'static str

Human-readable next step.

StaleAcknowledgement

A task acknowledgement no longer matches the stored lock state.

Fields

task_id: String

Task id involved in the acknowledgement.

queue: String

Queue involved in the acknowledgement.

worker_id: String

Worker id involved in the acknowledgement.

WorkerNotRegistered

A worker heartbeat could not be recorded because the worker row is absent.

Fields

operation: Cow<'static, str>

Backend operation that failed.

worker_id: String

Worker id involved in the operation.

queue: String

Queue involved in the operation.

hint: &'static str

Human-readable next step.

NotifyListener(String)

PostgreSQL notification listener failed.

SinkBufferFull(usize)

A sink producer attempted to send without observing backpressure.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: PoolError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.