Enum Error 

#[non_exhaustive]
pub enum Error {
    Io(Error),
    Escape(PathBuf),
    Drifted(PathBuf),
    InvalidJournalName(String),
    InvalidJournalHome(PathBuf),
    NonUtf8Path(PathBuf),
    Corrupt(String),
    Recovery(String),
    StaleJournal(PathBuf),
    Torn {
        cause: String,
        rollback: String,
    },
}

Everything applying or recovering a ChangeSet can fail with.

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.

Io(Error)

The backend refused an operation. The staged set is unwound before this surfaces, so the tree is as it was.

Escape(PathBuf)

A staged path resolved outside the root it was applied against — either absolute, or climbing past the root with ... Refused before anything is written or journaled, because a set assembled from untrusted data must not be able to reach out of the tree it was pointed at.

Drifted(PathBuf)

An expectation the set staged did not hold when it was applied: the tree at this path is not what the caller read when it computed the set — something else wrote in between. Refused before the commit point, so nothing has been written, journaled, or unwound; the caller re-reads, restages, and retries. This is drift detection, not a lock — see change on the single writer.

InvalidJournalName(String)

A Journal was asked for under a name that is not a single path component. Refused at construction, because the name is joined onto a caller-supplied root and one containing .. or a separator would write outside the very tree an apply clamps into.

InvalidJournalHome(PathBuf)

A Journal was asked to live (kept_in) in a directory that is not absolute. Refused at construction: a relative home resolves against the process’s current directory, which the apply that writes the journal and the recovery that must find it have no reason to share — and a journal sought where it was never written strands its change half-applied.

NonUtf8Path(PathBuf)

A staged path could not be encoded into the journal because it is not UTF-8. The journal stores paths as UTF-8 so that a set written on one platform replays identically on another; a path that cannot round-trip is refused at the commit point rather than silently mangled.

Corrupt(String)

A journal was found that could not be trusted: a bad magic, a checksum mismatch, a truncated record, an unknown op tag. Refused rather than partially replayed — a journal exists to prevent invented states, so one that cannot be read is never guessed at.

Recovery(String)

A journal was read successfully but could not be replayed to completion: a CopyFrom whose source has gone, or a rename with neither side present. Distinct from Corrupt — the intent was legible, the tree just could not be brought to it. The journal is left in place so a later recovery can finish once the missing piece is back.

StaleJournal(PathBuf)

A set was applied while a previous set’s journal was still on disk: an earlier change was interrupted and never recovered. Landing this set would overwrite the record needed to finish that one, so the apply refuses. Call recover first, then retry.

Torn

The apply could not deliver either of its two durable answers. The classic case: a staged op failed and the rollback that should have undone it failed too. Two rarer ones share the shape — a rollback that completed but whose certification (or the journal’s retirement) could not be made durable, and a set that applied and certified cleanly but whose journal could not be removed. In every case the crate says exactly what it can and cannot promise, rather than reporting a clean endpoint it cannot stand behind.

The journal is left in place wherever possible, so the next recover resolves the tree — rolling an uncertified set forward to the applied state, or no-op replaying an applied one and clearing the journal. Either way the tree lands somewhere nameable.

Fields

cause: String

The failure that triggered the rollback.

rollback: String

The failure the rollback itself hit.

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, f: &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(e: Error) -> Self

Converts to this type from the input type.