Enum Error

#[non_exhaustive]
pub enum Error {
    Configuration(Box<dyn Error + Sync + Send>),
    Database(Box<dyn DatabaseError>),
    Io(Error),
    Tls(Box<dyn Error + Sync + Send>),
    Protocol(String),
    RowNotFound,
    TypeNotFound {
        type_name: String,
    },
    ColumnIndexOutOfBounds {
        index: usize,
        len: usize,
    },
    ColumnNotFound(String),
    ColumnDecode {
        index: String,
        source: Box<dyn Error + Sync + Send>,
    },
    Encode(Box<dyn Error + Sync + Send>),
    Decode(Box<dyn Error + Sync + Send>),
    AnyDriverError(Box<dyn Error + Sync + Send>),
    PoolTimedOut,
    PoolClosed,
    WorkerCrashed,
    Migrate(Box<MigrateError>),
}

Represents all the ways a method can fail within SQLx.

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.

Configuration(Box<dyn Error + Sync + Send>)

Error occurred while parsing a connection string.

Database(Box<dyn DatabaseError>)

Error returned from the database.

Io(Error)

Error communicating with the database backend.

Tls(Box<dyn Error + Sync + Send>)

Error occurred while attempting to establish a TLS connection.

Protocol(String)

Unexpected or invalid data encountered while communicating with the database.

This should indicate there is a programming error in a SQLx driver or there is something corrupted with the connection to the database itself.

RowNotFound

No rows returned by a query that expected to return at least one row.

TypeNotFound

Type in query doesn’t exist. Likely due to typo or missing user type.

Fields

type_name: String

ColumnIndexOutOfBounds

Column index was out of bounds.

Fields

index: usize

len: usize

ColumnNotFound(String)

No column found for the given name.

ColumnDecode

Error occurred while decoding a value from a specific column.

Fields

index: String

source: Box<dyn Error + Sync + Send>

Encode(Box<dyn Error + Sync + Send>)

Error occured while encoding a value.

Decode(Box<dyn Error + Sync + Send>)

Error occurred while decoding a value.

AnyDriverError(Box<dyn Error + Sync + Send>)

Error occurred within the Any driver mapping to/from the native driver.

PoolTimedOut

A Pool::acquire timed out due to connections not becoming available or because another task encountered too many errors while trying to open a new connection.

PoolClosed

Pool::close was called while we were waiting in Pool::acquire.

WorkerCrashed

A background worker has crashed.

Migrate(Box<MigrateError>)

Implementations

impl Error

pub fn into_database_error(self) -> Option<Box<dyn DatabaseError>>

pub fn as_database_error(&self) -> Option<&(dyn DatabaseError + 'static)>

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<E> From<E> for Error

where E: DatabaseError,

fn from(error: E) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.

impl From<MigrateError> for Error

fn from(error: MigrateError) -> Error

Converts to this type from the input type.

impl From<Error> for MigrateError

fn from(source: Error) -> MigrateError

Converts to this type from the input type.