Enum InstanceError 

#[non_exhaustive]
pub enum InstanceError {
    DatabaseNotFound {
        name: String,
    },
    DatabaseAlreadyExists {
        name: String,
    },
    InstanceAlreadyExists,
    EntryNotInDatabase {
        entry_id: ID,
        database_id: ID,
    },
    EntryNotFound {
        entry_id: ID,
    },
    TransactionAlreadyCommitted,
    EmptyTipsNotAllowed,
    InvalidTip {
        tip_id: ID,
        database_id: ID,
    },
    SigningKeyNotFound {
        key_name: String,
    },
    AuthenticationRequired,
    DeviceKeyNotFound,
    NoAuthConfiguration,
    AuthenticationValidationFailed {
        reason: String,
    },
    InsufficientPermissions,
    SignatureVerificationFailed,
    InvalidDataType {
        expected: String,
        actual: String,
    },
    SerializationFailed {
        context: String,
    },
    InvalidDatabaseConfiguration {
        reason: String,
    },
    SettingsValidationFailed {
        reason: String,
    },
    InvalidOperation {
        reason: String,
    },
    DatabaseInitializationFailed {
        reason: String,
    },
    EntryValidationFailed {
        reason: String,
    },
    DatabaseStateCorruption {
        reason: String,
    },
    OperationNotSupported {
        operation: String,
    },
    InstanceDropped,
    SyncAlreadyEnabled,
    SystemDatabaseNotFound {
        database_name: String,
    },
}

Errors that can occur during base database operations.

Stability

• New variants may be added in minor versions (enum is #[non_exhaustive])
• Existing variants will not be removed in minor versions
• Field additions/changes require a major version bump
• Helper methods like is_*() provide stable APIs

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.

DatabaseNotFound

Database not found by name.

Fields

name: String

The name of the database that was not found

DatabaseAlreadyExists

Database already exists with the given name.

Fields

name: String

The name of the database that already exists

InstanceAlreadyExists

Instance already exists on this backend.

EntryNotInDatabase

Entry does not belong to the specified database.

Fields

entry_id: ID

The ID of the entry

database_id: ID

The ID of the database

EntryNotFound

Entry not found by ID.

Fields

entry_id: ID

The ID of the entry that was not found

TransactionAlreadyCommitted

Transaction has already been committed and cannot be modified.

EmptyTipsNotAllowed

Cannot create transaction with empty tips.

InvalidTip

Tip entry does not belong to the specified database.

Fields

tip_id: ID

The ID of the invalid tip entry

database_id: ID

The ID of the database

SigningKeyNotFound

Signing key not found in backend storage.

Fields

key_name: String

The name of the signing key that was not found

AuthenticationRequired

Authentication is required but no key is configured.

DeviceKeyNotFound

Device key not found in instance metadata.

NoAuthConfiguration

No authentication configuration found.

AuthenticationValidationFailed

Authentication validation failed.

Fields

reason: String

Description of why authentication validation failed

InsufficientPermissions

Insufficient permissions for the requested operation.

SignatureVerificationFailed

Signature verification failed.

InvalidDataType

Invalid data type encountered.

Fields

expected: String

The expected data type

actual: String

The actual data type found

SerializationFailed

Serialization failed.

Fields

context: String

The context where serialization failed

InvalidDatabaseConfiguration

Invalid database configuration.

Fields

reason: String

Description of why the database configuration is invalid

SettingsValidationFailed

Settings validation failed.

Fields

reason: String

Description of why settings validation failed

InvalidOperation

Invalid operation attempted.

Fields

reason: String

Description of why the operation is invalid

DatabaseInitializationFailed

Database initialization failed.

Fields

reason: String

Description of why database initialization failed

EntryValidationFailed

Entry validation failed.

Fields

reason: String

Description of why entry validation failed

DatabaseStateCorruption

Database state is corrupted or inconsistent.

Fields

reason: String

Description of the corruption detected

OperationNotSupported

Operation is not supported in the current mode or not yet implemented.

Fields

operation: String

Description of the unsupported operation

InstanceDropped

Instance has been dropped and is no longer available.

SyncAlreadyEnabled

Sync has already been enabled on this Instance.

SystemDatabaseNotFound

System database not found during instance initialization.

Fields

database_name: String

Name of the system database that was not found

Implementations

impl InstanceError

pub fn is_not_found(&self) -> bool

Check if this error indicates a resource was not found.

pub fn is_already_exists(&self) -> bool

Check if this error indicates a resource already exists.

pub fn is_authentication_error(&self) -> bool

Check if this error is authentication-related.

pub fn is_operation_error(&self) -> bool

Check if this error is operation-related.

pub fn is_validation_error(&self) -> bool

Check if this error is validation-related.

pub fn is_corruption_error(&self) -> bool

Check if this error indicates corruption or inconsistency.

pub fn entry_id(&self) -> Option<&ID>

Get the entry ID if this error is about a specific entry.

pub fn database_id(&self) -> Option<&ID>

Get the database ID if this error is about a specific database.

pub fn database_name(&self) -> Option<&str>

Get the database name if this error is about a named database.

Trait Implementations

impl Debug for InstanceError

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

Formats the value using the given formatter.

impl Display for InstanceError

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

Formats the value using the given formatter.

impl Error for InstanceError

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<InstanceError> for Error

fn from(err: InstanceError) -> Self

Converts to this type from the input type.