Enum CovenError 

pub enum CovenError {
    Key(KeyError),
    Rollback {
        operation: Box<CovenError>,
        rollback: SqliteError,
    },
    FileCleanup {
        write: Box<CovenError>,
        failures: Vec<DbError>,
    },
    Database(DbError),
    Sync(SyncError),
    Migration(MigrationError),
    CovenMigration(CovenMigrationError),
    Settings(SettingsError),
    File(FileError),
    Lock(StoreLockError),
    MissingConfiguration {
        field: &'static str,
    },
    DeviceKeyMissing {
        store: StoreId,
    },
    MemberKeysMissing {
        store: StoreId,
    },
    DeviceLocked {
        path: PathBuf,
    },
    Shutdown(Shutdown),
    Bug(Bug),
    NetworkWatch(NetworkWatchError),
}

Failures of opening, reading and writing a store (§4, E1, E3).

Variants

Key(KeyError)

Reading device identity or an app callback’s custody operation failed.

Rollback

An app callback failed and SQLite also failed to roll it back. Later calls fail with DbError::RollbackFailed until the store is reopened (§4).

Fields

operation: Box<CovenError>

The callback or database failure.

rollback: SqliteError

SQLite’s rollback failure.

FileCleanup

File cleanup failed after the callback failed, retaining both.

Fields

write: Box<CovenError>

The callback’s original error.

failures: Vec<DbError>

Each failed byte removal or pending-record update.

Database(DbError)

The database or a write’s validation failed.

Sync(SyncError)

A sync step failed inside an app’s write, which did not commit, or while the store opened, keeping sync’s own error (E1, E3).

Migration(MigrationError)

An app migration failed or cannot run on this schema.

CovenMigration(CovenMigrationError)

Coven’s internal schema is unsupported or its migration cannot run.

Settings(SettingsError)

The directory’s settings could not be read.

File(FileError)

A file operation in the store’s directory failed.

Lock(StoreLockError)

The writer’s lock could not be acquired.

MissingConfiguration

A required builder choice was not supplied (E1).

Fields

field: &'static str

The missing choice.

DeviceKeyMissing

The keychain holds no entry naming this directory’s device; opening changed nothing (§19.3).

Fields

store: StoreId

The store whose device entry is missing.

MemberKeysMissing

A connected store’s identity custody holds no member keys either, beside the missing device entry; only restoring with the restore code continues. Opening changed nothing (§19.3, §13).

Fields

store: StoreId

The store whose member keys are missing.

DeviceLocked

The device is locked, and the protection class the app chose keeps the store’s files closed until it unlocks; opening changed nothing the lock refused (api.md E1). The app waits for the unlock and opens again.

Fields

path: PathBuf

The first protected file the open was refused.

Shutdown(Shutdown)

The call’s runtime is shutting down and dropped coven’s work for it on the blocking pool unstarted, such as opening’s custody work, so that work changed nothing (E15). A database call dropped this way is DbError::Shutdown.

Bug(Bug)

Coven’s work for the call panicked on the blocking pool, such as opening’s custody work or a sync step: a bug, which the caller reports (E15). A database call that panicked is DbError::Bug.

NetworkWatch(NetworkWatchError)

The platform refused to let coven watch the device’s network, such as an Android app without coven’s Android library (api.md E1, E5).

Trait Implementations

impl CarriesBug for CovenError

fn bug(&self) -> Option<&Bug>

The bug this error carries, itself or through the failure it keeps.

impl Debug for CovenError

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

Formats the value using the given formatter.

impl Display for CovenError

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

Formats the value using the given formatter.

impl Error for CovenError

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<Bug> for CovenError

fn from(source: Bug) -> Self

Converts to this type from the input type.

impl From<CovenError> for BootstrapError

fn from(error: CovenError) -> Self

Converts to this type from the input type.

impl From<CovenError> for ReadOnlyOpenError

fn from(error: CovenError) -> Self

Converts to this type from the input type.

impl From<CovenError> for StoreCreationError

fn from(error: CovenError) -> Self

Converts to this type from the input type.

impl From<CovenMigrationError> for CovenError

fn from(source: CovenMigrationError) -> Self

Converts to this type from the input type.

impl From<DbError> for CovenError

fn from(source: DbError) -> Self

Converts to this type from the input type.

impl From<FileError> for CovenError

fn from(error: FileError) -> Self

Converts to this type from the input type.

impl From<KeyError> for CovenError

fn from(error: KeyError) -> Self

Converts to this type from the input type.

impl From<MigrationError> for CovenError

fn from(source: MigrationError) -> Self

Converts to this type from the input type.

impl From<NetworkWatchError> for CovenError

fn from(source: NetworkWatchError) -> Self

Converts to this type from the input type.

impl From<OpenError> for CovenError

Opening the database fails as the app’s open call reports it, each cause under its own name.

fn from(error: OpenError) -> Self

Converts to this type from the input type.

impl From<SettingsError> for CovenError

fn from(error: SettingsError) -> Self

Converts to this type from the input type.

impl From<Shutdown> for CovenError

fn from(source: Shutdown) -> Self

Converts to this type from the input type.

impl From<Error> for CovenError

fn from(error: SqliteError) -> Self

Converts to this type from the input type.

impl From<StoreLockError> for CovenError

fn from(error: StoreLockError) -> Self

Converts to this type from the input type.

impl From<SyncError> for CovenError

A sync step’s failure inside an app’s write or while the store opens: a database failure as itself, a bug or shutdown as the call’s own, and any other as the step’s own error (§4, E15).

fn from(error: SyncError) -> Self

Converts to this type from the input type.

impl From<TaskFailed> for CovenError

fn from(failed: TaskFailed) -> Self

Converts to this type from the input type.

impl WriteFailure for CovenError

An app’s write failing with CovenError keeps a failed rollback or byte removal in the error it wraps: the database’s and a sync step’s in their own, any other beside it (Appendix C.3).

fn with_rollback(self, rollback: SqliteError) -> Self

Retain a failed rollback alongside the original failure.

fn with_cleanup(write: Self, failures: Vec<DbError>) -> Self

Retain the failed write’s error and every failed byte-removal operation.