Enum PulseDBError 

pub enum PulseDBError {
    Storage(StorageError),
    Validation(ValidationError),
    Config {
        reason: String,
    },
    NotFound(NotFoundError),
    Io(Error),
    Embedding(String),
    Vector(String),
    Watch(String),
    Internal(String),
    Sync(SyncError),
}

Top-level error enum for all PulseDB operations.

This is the only error type returned by public APIs. Use pattern matching to handle specific error cases.

Variants

Storage(StorageError)

Storage layer error (I/O, corruption, transactions).

Validation(ValidationError)

Input validation error.

Config

Configuration error.

Fields

reason: String

Description of what’s wrong with the configuration.

NotFound(NotFoundError)

Requested entity not found.

Io(Error)

General I/O error.

Embedding(String)

Embedding generation/validation error.

Vector(String)

Vector index error (HNSW operations).

Watch(String)

Watch system error (subscription or event delivery).

Internal(String)

Internal error (e.g., async runtime failure, task join error).

Sync(SyncError)

Available on crate feature sync only.

Sync protocol error.

Only available when the sync feature is enabled.

Implementations

impl PulseDBError

pub fn config(reason: impl Into<String>) -> Self

Creates a configuration error with the given reason.

pub fn embedding(msg: impl Into<String>) -> Self

Creates an embedding error with the given message.

pub fn vector(msg: impl Into<String>) -> Self

Creates a vector index error with the given message.

pub fn watch(msg: impl Into<String>) -> Self

Creates a watch system error with the given message.

pub fn internal(msg: impl Into<String>) -> Self

Creates an internal error with the given message.

pub fn is_not_found(&self) -> bool

Returns true if this is a “not found” error.

pub fn is_validation(&self) -> bool

Returns true if this is a validation error.

pub fn is_storage(&self) -> bool

Returns true if this is a storage error.

pub fn is_vector(&self) -> bool

Returns true if this is a vector index error.

pub fn is_watch(&self) -> bool

Returns true if this is a watch system error.

pub fn is_embedding(&self) -> bool

Returns true if this is an embedding error.

pub fn is_internal(&self) -> bool

Returns true if this is an internal error.

pub fn is_config(&self) -> bool

Returns true if this is a configuration error.

pub fn is_io(&self) -> bool

Returns true if this is an I/O error.

pub fn is_sync(&self) -> bool

Available on crate feature sync only.

Returns true if this is a sync error.

Only available when the sync feature is enabled.

Trait Implementations

impl Debug for PulseDBError

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

Formats the value using the given formatter.

impl Display for PulseDBError

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

Formats the value using the given formatter.

impl Error for PulseDBError

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<Box<ErrorKind>> for PulseDBError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<CommitError> for PulseDBError

fn from(err: CommitError) -> Self

Converts to this type from the input type.

impl From<DatabaseError> for PulseDBError

fn from(err: DatabaseError) -> Self

Converts to this type from the input type.

impl From<Error> for PulseDBError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for PulseDBError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<NotFoundError> for PulseDBError

fn from(source: NotFoundError) -> Self

Converts to this type from the input type.

impl From<StorageError> for PulseDBError

fn from(source: StorageError) -> Self

Converts to this type from the input type.

impl From<StorageError> for PulseDBError

fn from(err: StorageError) -> Self

Converts to this type from the input type.

impl From<SyncError> for PulseDBError

fn from(source: SyncError) -> Self

Converts to this type from the input type.

impl From<TableError> for PulseDBError

fn from(err: TableError) -> Self

Converts to this type from the input type.

impl From<TransactionError> for PulseDBError

fn from(err: TransactionError) -> Self

Converts to this type from the input type.

impl From<ValidationError> for PulseDBError

fn from(source: ValidationError) -> Self

Converts to this type from the input type.