Enum AtomwriteError 

#[non_exhaustive]
pub enum AtomwriteError {
    NotFound {
        path: PathBuf,
    },
    InvalidInput {
        reason: String,
    },
    PermissionDenied {
        path: PathBuf,
    },
    DiskFull {
        path: PathBuf,
    },
    QuotaExceeded {
        path: PathBuf,
    },
    CrossDevice {
        path: PathBuf,
    },
    Io {
        source: Error,
    },
    ConfigInvalid {
        reason: String,
    },
    StateDrift {
        path: PathBuf,
        expected: String,
        actual: String,
    },
    WorkspaceJail {
        path: PathBuf,
        workspace: PathBuf,
    },
    SymlinkBlocked {
        path: PathBuf,
    },
    FileImmutable {
        path: PathBuf,
    },
    BinaryFile {
        path: PathBuf,
    },
    FifoDetected {
        path: PathBuf,
    },
    DeviceFile {
        path: PathBuf,
    },
    ChecksumVerifyFailed {
        path: PathBuf,
        expected: String,
    },
    FileTooLarge {
        path: PathBuf,
        size: u64,
        max_size: u64,
    },
    NoMatches,
    BrokenPipe,
    InternalError {
        reason: String,
    },
}

Domain-specific errors for atomic file operations.

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.

NotFound

Target file does not exist.

Fields

path: PathBuf

File path that was not found.

InvalidInput

Caller-provided input failed validation.

Fields

reason: String

Description of the validation failure.

PermissionDenied

Insufficient filesystem permissions.

Fields

path: PathBuf

File path with insufficient permissions.

DiskFull

No space left on the device.

Fields

path: PathBuf

File path where the write failed.

QuotaExceeded

Filesystem quota exceeded.

Fields

path: PathBuf

File path where quota was exceeded.

CrossDevice

Rename attempted across different mount points.

Fields

path: PathBuf

File path involved in cross-device rename.

Io

Wrapped standard I/O error.

Fields

source: Error

Underlying I/O error.

ConfigInvalid

Invalid CLI or runtime configuration.

Fields

reason: String

Description of the configuration problem.

StateDrift

File checksum changed between read and write (optimistic lock failure).

Fields

path: PathBuf

File path with checksum mismatch.

expected: String

Caller-provided expected checksum.

actual: String

Actual checksum found on disk.

WorkspaceJail

Path resolved outside the workspace jail boundary.

Fields

path: PathBuf

Path that escaped the workspace jail.

workspace: PathBuf

Workspace root used for comparison.

SymlinkBlocked

Symbolic link encountered when symlinks are disallowed.

Fields

path: PathBuf

Symlink path that was blocked.

FileImmutable

File has immutable attributes preventing modification.

Fields

path: PathBuf

Immutable file path.

BinaryFile

File detected as binary when text-only mode is required.

Fields

path: PathBuf

Binary file path.

FifoDetected

FIFO or named pipe detected where regular file expected.

Fields

path: PathBuf

FIFO path.

DeviceFile

Block or character device file detected.

Fields

path: PathBuf

Device file path.

ChecksumVerifyFailed

Checksum verification failed (hash –verify mismatch).

Fields

path: PathBuf

File path with checksum mismatch.

expected: String

Caller-provided expected checksum.

FileTooLarge

File exceeds the configured maximum size.

Fields

path: PathBuf

Path to the oversized file.

size: u64

Actual file size in bytes.

max_size: u64

Configured maximum size in bytes.

NoMatches

Search or replace found zero matches.

BrokenPipe

Downstream consumer closed the output pipe.

InternalError

Unexpected internal error.

Fields

reason: String

Description of the internal failure.

Implementations

impl AtomwriteError

pub const fn exit_code(&self) -> u8

Return the process exit code for this error variant.

pub const fn error_class(&self) -> ErrorClass

Classify the error for retry decisions.

pub fn is_retryable(&self) -> bool

Return true if the error class indicates a retry may succeed.

Retryable variants (transient): Self::DiskFull, Self::QuotaExceeded, Self::Io. Retryable variants (conflict): Self::StateDrift, Self::CrossDevice.

All other variants are non-retryable (precondition or permanent).

pub fn is_permanent(&self) -> bool

Return true if retrying this error will never succeed.

Permanent errors include: Self::NotFound, Self::InvalidInput, Self::PermissionDenied, Self::ConfigInvalid, Self::NoMatches, Self::BrokenPipe, and Self::InternalError.

pub const fn error_code(&self) -> &'static str

Return the machine-readable error code string for NDJSON output.

pub fn path(&self) -> Option<&PathBuf>

Return the filesystem path associated with this error, if any.

Trait Implementations

impl Debug for AtomwriteError

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

Formats the value using the given formatter.

impl Display for AtomwriteError

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

Formats the value using the given formatter.

impl Error for AtomwriteError

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 AtomwriteError

fn from(source: Error) -> Self

Converts to this type from the input type.