Enum DatabaseError 

pub enum DatabaseError {
    SqlxError(Error),
    InvalidData(String),
}

A generic Error type to be used for functions that perform DB operations.

Note regarding sqlx Errors: Most sqlx errors are of technical nature (like ConnectionPool exhausted, connection unexpectedly closed, timeouts). These are likely not handled specifically by calling code, and mostly just cause the operation to fail.

Some sqlx errors (such as ConstraintViolation) may actually be useful for the caller. For example, in a signup process, we may very well want to handle the case where an email address is already registered. In this case, the recommended pattern is to create a new error type containing the errors you want the caller to handle explicitly, and include a variant that holds the DatabaseError. This makes it very clear to the caller what application-level conditions may occur.

Example:

#[derive(thiserror::Error, Debug)]
enum SignupError {
	// This typically comes from a sqlx constraint violation, but we want
	// the caller to handle this explicitly.
	#[error("username already taken")]
	UsernameAlreadyTaken,

	// All other "uninteresting" sqlx errors will be signaled via the DatabaseError.
	#[error(transparent)]
	DatabaseError(arminius_lib_db::DatabaseError),
}

Trivial query functions (like simple SELECT queries) that do not have any non-technical error cases may of course return this type directly.

Variants

SqlxError(Error)

An sqlx error.

InvalidData(String)

Unexpected content read from the database. E.g. a JSON field failed to deserialize, a field did not conform to a specific format (like an email address) etc

Trait Implementations

impl Debug for DatabaseError

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

Formats the value using the given formatter.

impl Display for DatabaseError

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

Formats the value using the given formatter.

impl Error for DatabaseError

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 DatabaseError

fn from(value: Error) -> Self

Converts to this type from the input type.