Struct Error 

pub struct Error(/* private fields */);

An error, carrying a code, a message and optionally where in the query it happened.

The payload is boxed so that Error is one pointer wide, which keeps Result<T> the same size as T for every T that has a niche. Errors are rare and results are returned from every function in the workspace, so the cost belongs on the rare path.

Implementations

impl Error

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

An error with a code and a message and no span.

pub fn with_span(self, span: Span) -> Self

The same error, with the part of the query it is about.

pub fn code(&self) -> ErrorCode

What kind of thing went wrong.

pub fn message(&self) -> &str

The message, without the code prefix that Display adds.

pub fn span(&self) -> Option<Span>

Where in the query text this is about, if it is about a place.

pub fn parser(message: impl Into<String>) -> Self

The text is not SQL.

pub fn syntax(message: impl Into<String>) -> Self

The text is SQL and a value in it is not one the statement can take.

pub fn binder(message: impl Into<String>) -> Self

The text is SQL and it does not mean anything.

pub fn catalog(message: impl Into<String>) -> Self

A named object is missing, or one that should be missing is not.

pub fn conversion(message: impl Into<String>) -> Self

A value will not convert to the type it is being asked for.

pub fn out_of_range(message: impl Into<String>) -> Self

A value is outside what its type can hold.

pub fn invalid_input(message: impl Into<String>) -> Self

An argument is wrong in a way that is not a type error.

pub fn out_of_memory(message: impl Into<String>) -> Self

An allocation failed or a memory limit was reached.

pub fn io(message: impl Into<String>) -> Self

The filesystem, the network or the object store said no.

pub fn not_implemented(message: impl Into<String>) -> Self

It is in the plan and it is not built yet.

pub fn constraint(message: impl Into<String>) -> Self

A constraint was violated.

pub fn transaction(message: impl Into<String>) -> Self

A conflict, an abort, or a statement issued outside a transaction that needs one.

pub fn interrupt(message: impl Into<String>) -> Self

The query was cancelled.

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

An invariant this code is responsible for does not hold.

Reaching this is always a bug in the database and never a bug in the query, which is why it reads differently from the others and why the fuzzer treats it as a finding.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

fn from(error: Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error