Enum rusqlite::Error

#[non_exhaustive]
pub enum Error {
    SqliteFailure(Error, Option<String>),
    SqliteSingleThreadedMode,
    FromSqlConversionFailure(usize, Type, Box<dyn Error + Send + Sync + 'static>),
    IntegralValueOutOfRange(usize, i64),
    Utf8Error(Utf8Error),
    NulError(NulError),
    InvalidParameterName(String),
    InvalidPath(PathBuf),
    ExecuteReturnedResults,
    QueryReturnedNoRows,
    InvalidColumnIndex(usize),
    InvalidColumnName(String),
    InvalidColumnType(usize, String, Type),
    StatementChangedRows(usize),
    InvalidFunctionParameterType(usize, Type),
    InvalidFilterParameterType(usize, Type),
    UserFunctionError(Box<dyn Error + Send + Sync + 'static>),
    ToSqlConversionFailure(Box<dyn Error + Send + Sync + 'static>),
    InvalidQuery,
    ModuleError(String),
    UnwindingPanic,
    GetAuxWrongType,
    MultipleStatement,
    InvalidParameterCount(usize, usize),
    BlobSizeError,
    SqlInputError {
        error: Error,
        msg: String,
        sql: String,
        offset: c_int,
    },
}

Enum listing possible errors from rusqlite.

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.

SqliteFailure(Error, Option<String>)

An error from an underlying SQLite call.

SqliteSingleThreadedMode

Error reported when attempting to open a connection when SQLite was configured to allow single-threaded use only.

FromSqlConversionFailure(usize, Type, Box<dyn Error + Send + Sync + 'static>)

Error when the value of a particular column is requested, but it cannot be converted to the requested Rust type.

IntegralValueOutOfRange(usize, i64)

Error when SQLite gives us an integral value outside the range of the requested type (e.g., trying to get the value 1000 into a u8). The associated usize is the column index, and the associated i64 is the value returned by SQLite.

Utf8Error(Utf8Error)

Error converting a string to UTF-8.

NulError(NulError)

Error converting a string to a C-compatible string because it contained an embedded nul.

InvalidParameterName(String)

Error when using SQL named parameters and passing a parameter name not present in the SQL.

InvalidPath(PathBuf)

Error converting a file path to a string.

ExecuteReturnedResults

Error returned when an execute call returns rows.

QueryReturnedNoRows

Error when a query that was expected to return at least one row (e.g., for query_row) did not return any.

InvalidColumnIndex(usize)

Error when the value of a particular column is requested, but the index is out of range for the statement.

InvalidColumnName(String)

Error when the value of a named column is requested, but no column matches the name for the statement.

InvalidColumnType(usize, String, Type)

Error when the value of a particular column is requested, but the type of the result in that column cannot be converted to the requested Rust type.

StatementChangedRows(usize)

Error when a query that was expected to insert one row did not insert any or insert many.

InvalidFunctionParameterType(usize, Type)

Available on crate feature functions only.

Error returned by functions::Context::get when the function argument cannot be converted to the requested type.

InvalidFilterParameterType(usize, Type)

Available on crate feature vtab only.

Error returned by vtab::Values::get when the filter argument cannot be converted to the requested type.

UserFunctionError(Box<dyn Error + Send + Sync + 'static>)

Available on crate feature functions only.

An error case available for implementors of custom user functions (e.g., create_scalar_function).

ToSqlConversionFailure(Box<dyn Error + Send + Sync + 'static>)

Error available for the implementors of the ToSql trait.

InvalidQuery

Error when the SQL is not a SELECT, is not read-only.

ModuleError(String)

Available on crate feature vtab only.

An error case available for implementors of custom modules (e.g., create_module).

UnwindingPanic

Available on crate feature functions only.

An unwinding panic occurs in an UDF (user-defined function).

GetAuxWrongType

Available on crate feature functions only.

An error returned when Context::get_aux attempts to retrieve data of a different type than what had been stored using Context::set_aux.

MultipleStatement

Error when the SQL contains multiple statements.

InvalidParameterCount(usize, usize)

Error when the number of bound parameters does not match the number of parameters in the query. The first usize is how many parameters were given, the 2nd is how many were expected.

BlobSizeError

Available on crate feature blob only.

Returned from various functions in the Blob IO positional API. For example, Blob::raw_read_at_exact will return it if the blob has insufficient data.

SqlInputError

Fields

error: Error

error code

msg: String

error message

sql: String

SQL input

offset: c_int

byte offset of the start of invalid token

Available on crate feature modern_sqlite only.

Error referencing a specific token in the input SQL

Implementations

impl Error

pub fn sqlite_error(&self) -> Option<&Error>

Returns the underlying SQLite error if this is Error::SqliteFailure.

pub fn sqlite_error_code(&self) -> Option<ErrorCode>

Returns the underlying SQLite error code if this is Error::SqliteFailure.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

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 Error

Available on crate features csvtab and vtab only.

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<FromSqlError> for Error

The conversion isn’t precise, but it’s convenient to have it to allow use of get_raw(…).as_…()? in callbacks that take Error.

fn from(err: FromSqlError) -> Error

Converts to this type from the input type.

impl From<NulError> for Error

fn from(err: NulError) -> Error

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(err: Utf8Error) -> Error

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.