Enum DbError 

#[non_exhaustive]
pub enum DbError {
    Sqlite(Error),
    SqlcipherFeatureRequired,
    InvalidSqlcipherKey,
    Integrity(String),
    InvalidQuarantineSuffix(String),
    InvalidPoolCapacity,
    InvalidReaderCacheSize(u32),
    ReadPoolClosed,
    ReadPoolCloseTimeout {
        outstanding: usize,
        timeout: Duration,
    },
    ReadOnlyNotEffective(String),
    InvalidDatabasePath,
    SymlinkedStorePath(String),
    NewerDatabase {
        current: i64,
        max: i64,
    },
    InvalidMigrations(String),
    MigrationFailed {
        version: i64,
        name: &'static str,
        source: Error,
    },
    Rollback(String),
    Backup(String),
    RestoreFailed {
        message: String,
        previous: Option<PathBuf>,
        failed_copy: Option<PathBuf>,
        rolled_back: bool,
    },
    NoKeyOpened,
    Fs(FsError),
    Unreadable {
        path: PathBuf,
        cause: UnreadableCause,
        consecutive_failures: u32,
        quarantine_after: Option<u32>,
        source: Box<DbError>,
    },
}

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.

Sqlite(Error)

SqlcipherFeatureRequired

InvalidSqlcipherKey

Integrity(String)

An open-time quick_check or integrity_check failed. Open-time recovery treats it as an unreadable database (see DbOptions::open_writer_recovering).

InvalidQuarantineSuffix(String)

InvalidPoolCapacity

InvalidReaderCacheSize(u32)

ReadPoolClosed

Checkout after ReadPool::close or ReadPool::close_and_wait.

ReadPoolCloseTimeout

ReadPool::close_and_wait timed out. outstanding counts readers still checked out or opening.

Fields

outstanding: usize

timeout: Duration

ReadOnlyNotEffective(String)

A reader did not come up read-only: PRAGMA query_only did not stay on, or a read-only handle reported a writable main database.

InvalidDatabasePath

SymlinkedStorePath(String)

The store path is a symbolic link (a dangling one included) and was refused before SQLite could create or open its target. Carries the path as given.

NewerDatabase

Fields

current: i64

max: i64

InvalidMigrations(String)

MigrationFailed

Fields

version: i64

name: &'static str

source: Error

Rollback(String)

Backup(String)

RestoreFailed

restore_database failed. previous is where the previous store is kept when it is not at the live path (never deleted); failed_copy is where the restored copy was set aside. rolled_back is true when the live path holds the previous store again (or was never touched); false means the rollback was incomplete, a restore journal remains, and recover_interrupted_restore finishes it.

Fields

message: String

previous: Option<PathBuf>

failed_copy: Option<PathBuf>

rolled_back: bool

NoKeyOpened

Fs(FsError)

Unreadable

The database file could not be read (permission or I/O failure) or its storage is unavailable. Not corruption: the file was not touched unless quarantine_after was reached, in which case recovery succeeds instead of returning this. See UnreadablePolicy.

Fields

path: PathBuf

cause: UnreadableCause

consecutive_failures: u32

Consecutive failed opens recorded so far (0 under UnreadablePolicy::Fail and for storage problems, which are never counted).

quarantine_after: Option<u32>

The count at which UnreadablePolicy::QuarantineAfter would set the file aside.

source: Box<DbError>

Trait Implementations

impl Debug for DbError

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

Formats the value using the given formatter.

impl Display for DbError

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

Formats the value using the given formatter.

impl Error for DbError

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 DbError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FsError> for DbError

fn from(source: FsError) -> Self

Converts to this type from the input type.