Struct Error 

pub struct Error { /* private fields */ }

Represents an error in SurrealDB

Designed to be returned from public APIs (including over the wire). It is wire-friendly and non-lossy: serialization preserves kind, message, and optional details. Use this type whenever an error crosses an API boundary (e.g. server response, SDK method return).

The details field is flattened into the serialized object, so the wire format contains kind (string) and optionally details (object) at the same level as code and message. The optional cause field allows error chaining so that SDKs can receive and display full error chains.

Implementations

impl Error

pub fn validation( message: String, details: impl Into<Option<ValidationError>>, ) -> Self

Validation error (parse error, invalid request or params), with optional structured details. When details is provided, the wire code is set from the variant (e.g. Parse → PARSE_ERROR).

pub fn not_allowed( message: String, details: impl Into<Option<NotAllowedError>>, ) -> Self

Not-allowed error (e.g. method, scripting, function, net target), with optional structured details. When details is provided, the wire code is set from the variant.

pub fn configuration( message: String, details: impl Into<Option<ConfigurationError>>, ) -> Self

Configuration error (feature or config not supported), with optional structured details. When details is provided, the wire code is set from the variant.

pub fn thrown(message: String) -> Self

User-thrown error (e.g. from THROW in SurrealQL). Sets wire code for RPC.

pub fn query(message: String, details: impl Into<Option<QueryError>>) -> Self

Query execution error (not executed, timeout, cancelled), with optional structured details. When details is provided, the wire code is set from the variant.

pub fn serialization( message: String, details: impl Into<Option<SerializationError>>, ) -> Self

Serialisation or deserialisation error, with optional structured details. When details is provided, the wire code is set from the variant.

pub fn not_found( message: String, details: impl Into<Option<NotFoundError>>, ) -> Self

Resource not found (e.g. table, record, namespace, RPC method), with optional structured details. When details is NotFoundError::Method, the wire code is set to METHOD_NOT_FOUND for RPC backwards compatibility.

pub fn already_exists( message: String, details: impl Into<Option<AlreadyExistsError>>, ) -> Self

Resource already exists (e.g. table, record), with optional structured details.

pub fn connection( message: String, details: impl Into<Option<ConnectionError>>, ) -> Self

Connection error (e.g. uninitialised, already connected), with optional structured details. Used in the SDK for client-side connection state errors.

pub fn internal(message: String) -> Self

Internal or unexpected error (server or client). Sets wire code for RPC.

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

Returns the optional underlying cause for error chaining.

pub fn with_cause(self, cause: Error) -> Self

Returns an error with the given cause attached. Consumes self.

pub fn kind_str(&self) -> &'static str

Returns the kind string for this error (e.g. “NotAllowed”, “Internal”).

pub fn message(&self) -> &str

Returns the human-readable error message.

pub fn details(&self) -> &ErrorDetails

Returns the error details (always present). The variant determines the error kind.

pub fn is_validation(&self) -> bool

Returns true if this is a validation error.

pub fn is_configuration(&self) -> bool

Returns true if this is a configuration error.

pub fn is_query(&self) -> bool

Returns true if this is a query error.

pub fn is_serialization(&self) -> bool

Returns true if this is a serialization error.

pub fn is_not_allowed(&self) -> bool

Returns true if this is a not-allowed error.

pub fn is_not_found(&self) -> bool

Returns true if this is a not-found error.

pub fn is_already_exists(&self) -> bool

Returns true if this is an already-exists error.

pub fn is_connection(&self) -> bool

Returns true if this is a connection error.

pub fn is_thrown(&self) -> bool

Returns true if this is a user-thrown error.

pub fn is_internal(&self) -> bool

Returns true if this is an internal error.

pub fn validation_details(&self) -> Option<&ValidationError>

Returns structured validation error details, if this is a validation error with specifics.

pub fn not_allowed_details(&self) -> Option<&NotAllowedError>

Returns structured not-allowed error details, if this is a not-allowed error with specifics.

pub fn configuration_details(&self) -> Option<&ConfigurationError>

Returns structured configuration error details, if this is a configuration error with specifics.

pub fn serialization_details(&self) -> Option<&SerializationError>

Returns structured serialization error details, if this is a serialization error with specifics.

pub fn not_found_details(&self) -> Option<&NotFoundError>

Returns structured not-found error details, if this is a not-found error with specifics.

pub fn query_details(&self) -> Option<&QueryError>

Returns structured query error details, if this is a query error with specifics.

pub fn already_exists_details(&self) -> Option<&AlreadyExistsError>

Returns structured already-exists error details, if this is an already-exists error with specifics.

pub fn connection_details(&self) -> Option<&ConnectionError>

Returns structured connection error details, if this is a connection error with specifics.

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

fn from(e: ConversionError) -> Self

Converts to this type from the input type.

impl From<LengthMismatchError> for Error

fn from(e: LengthMismatchError) -> Self

Converts to this type from the input type.

impl From<OutOfRangeError> for Error

fn from(e: OutOfRangeError) -> Self

Converts to this type from the input type.

impl From<TypeError> for Error

fn from(e: TypeError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl SurrealValue for Error

fn into_value(self) -> Value

Converts this type into a SurrealDB value

fn from_value(value: Value) -> Result<Self, Error>

Attempts to convert a SurrealDB value into this type

fn is_value(value: &Value) -> bool

Checks if the given value can be converted to this type

fn kind_of() -> Kind

Returns the kind that represents this type

impl Eq for Error

impl StructuralPartialEq for Error