Enum SpoolError 

#[non_exhaustive]
pub enum SpoolError {
    PrepareDir {
        path: PathBuf,
        source: Error,
    },
    Encode {
        delivery_id: String,
        source: Error,
    },
    Write {
        path: PathBuf,
        source: Error,
    },
    Commit {
        from: PathBuf,
        to: PathBuf,
        source: Error,
    },
    SyncDir {
        path: PathBuf,
        source: Error,
    },
    AlreadyExists {
        path: PathBuf,
    },
    ReadDir {
        path: PathBuf,
        source: Error,
    },
    Remove {
        path: PathBuf,
        source: Error,
    },
}

Failures of the durable-write path. Every variant means the delivery is not safely recorded, so every one of them must reach the HTTP caller as a 5xx rather than a log line.

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.

PrepareDir

The spool directory could not be created or hardened.

Fields

path: PathBuf

Directory that could not be prepared.

source: Error

Underlying OS error.

Encode

Serialising the entry failed.

Fields

delivery_id: String

Delivery that could not be encoded.

source: Error

Underlying serde error.

Write

Writing or fsyncing the temp file failed — disk full, permission, or a genuine fsync error.

Fields

path: PathBuf

Temp path that could not be written.

source: Error

Underlying OS error.

Commit

The atomic rename into place failed.

Fields

from: PathBuf

Temp path.

to: PathBuf

Final path.

source: Error

Underlying OS error.

SyncDir

The directory fsync that makes the rename durable failed.

Fields

path: PathBuf

Directory that could not be synced.

source: Error

Underlying OS error.

AlreadyExists

An entry already exists at the path a fresh delivery derives.

Defensive: GitHub always sends X-GitHub-Delivery, so two deliveries only collide when the header is absent AND they land in the same millisecond. Refusing is still the right answer — clobbering would destroy a delivery that has already been acknowledged.

Fields

path: PathBuf

Path that was already taken.

ReadDir

Listing the spool failed. Surfaced as a red health state rather than an empty (and therefore falsely healthy) listing.

Fields

path: PathBuf

Directory that could not be read.

source: Error

Underlying OS error.

Remove

Deleting an acknowledged entry failed.

Fields

path: PathBuf

Entry that could not be removed.

source: Error

Underlying OS error.

Trait Implementations

impl Debug for SpoolError

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

Formats the value using the given formatter.

impl Display for SpoolError

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

Formats the value using the given formatter.

impl Error for SpoolError

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.