Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 21 variants NotRepository(PathBuf), NotFound(String), InvalidId(String), InvalidInput(String), IdempotencyConflict, IdempotencyNotFound, InvalidState { id: String, state: String, expected: String, }, UnsafeState(String), ForeignWorktree(PathBuf), UnsealedChanges(String), ResultDrift(String), DirtyIntegrationTarget(PathBuf), Git { command: String, status: i32, stderr: String, }, GitOutputTooLarge { command: String, cap: usize, }, NonUtf8Path(PathBuf), SchemaVersion { found: u32, supported: u32, }, ArtifactNotFound(String), Verification(String), Io { path: PathBuf, source: Error, }, Json { path: PathBuf, source: Error, }, CaptureWorker,
}
Expand description

Everything that can go wrong in a capsule operation.

Variants are deliberately specific so callers can branch on failure without parsing messages. The capsule binary maps each variant to a stable kind string in its JSON error output.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

NotRepository(PathBuf)

The given path is not inside a Git repository.

§

NotFound(String)

No capsule with this identifier exists.

§

InvalidId(String)

The identifier is not a well-formed capsule ID.

§

InvalidInput(String)

Caller input was missing, malformed, or out of bounds.

§

IdempotencyConflict

An existing key is permanently bound to a materially different creation request.

§

IdempotencyNotFound

No reservation exists for the requested state-root-scoped idempotency key.

§

InvalidState

The operation is not allowed from the capsule’s current state.

Fields

§id: String

Capsule the operation targeted.

§state: String

State it was actually in.

§expected: String

State or states the operation requires.

§

UnsafeState(String)

Stored state is inconsistent, unsafely shaped, or self-contradictory.

§

ForeignWorktree(PathBuf)

A path no longer proves it is the worktree the capsule created.

Returned instead of deleting anything, even under --force.

§

UnsealedChanges(String)

Cleanup was requested for a capsule whose work is not sealed.

§

ResultDrift(String)

Tracked content or result artifacts changed after the result was sealed.

§

DirtyIntegrationTarget(PathBuf)

The integration target has uncommitted changes.

§

Git

A Git subprocess exited unsuccessfully.

Fields

§command: String

Command that was run.

§status: i32

Exit status it returned.

§stderr: String

Captured standard error, bounded in size.

§

GitOutputTooLarge

A Git subprocess produced more output than its in-memory bound allows.

Fields

§command: String

Command that produced the output.

§cap: usize

Bound that was exceeded, in bytes.

§

NonUtf8Path(PathBuf)

A path cannot be represented in the UTF-8 result inventory.

§

SchemaVersion

Stored state was written by an incompatible schema version.

Fields

§found: u32

Version found on disk.

§supported: u32

Version this build supports.

§

ArtifactNotFound(String)

The requested artifact is not part of this capsule’s sealed result.

§

Verification(String)

An exported receipt failed verification.

§

Io

A filesystem operation failed.

Fields

§path: PathBuf

Path being operated on.

§source: Error

Underlying failure.

§

Json

Stored or supplied JSON could not be decoded or encoded.

Fields

§path: PathBuf

Path the JSON came from.

§source: Error

Underlying failure.

§

CaptureWorker

An internal thread draining Git output failed.

Trait Implementations§

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for Error

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Error

§

impl !UnwindSafe for Error

§

impl Freeze for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.