Enum Error 

pub enum Error {
    Connection {
        message: String,
        sqlstate: Option<String>,
    },
    Authentication(String),
    Query {
        message: String,
        sqlstate: Option<String>,
        detail: Option<String>,
        hint: Option<String>,
    },
    Protocol(String),
    Io(String),
    Config(String),
    Timeout(String),
    Cancelled {
        message: String,
        sqlstate: Option<String>,
    },
    Closed {
        message: String,
        sqlstate: Option<String>,
    },
    Conversion(String),
    FeatureNotSupported(String),
    Other(String),
}

The error type for Hyper client operations.

Variants that can carry a server-supplied SQLSTATE expose it as a field, so callers match on it structurally rather than scraping the message. The remaining variants are single-string: whatever context exists is already rendered into that string by the constructor.

Deliberately not #[non_exhaustive]. That attribute buys forward-compatibility for downstream matches, which this type has no use for: it is internal, not re-exported, and hyperdb-api is its only consumer and ships from this same workspace in lockstep. What it would cost is the compile-time exhaustiveness check on From<client::Error> for hyperdb_api::Error — the one place a new variant must be given a public mapping. Better that adding a variant breaks that build than silently degrades to Error::Internal.

Variants

Connection

Connection failed.

Fields

message: String

Human-readable description of the failure.

sqlstate: Option<String>

SQLSTATE, when the failure arrived from the server (gRPC reports connection-class SQLSTATEs in the 08xxx family).

Authentication(String)

Authentication failed.

Query

Query execution failed.

The one variant that carries the server’s full diagnostic payload — DETAIL and HINT are surfaced verbatim by the public hyperdb_api::Error::Server variant this maps to.

Fields

message: String

The primary error message.

sqlstate: Option<String>

SQLSTATE code, when the server supplied one.

detail: Option<String>

The server’s DETAIL field.

hint: Option<String>

The server’s HINT field.

Protocol(String)

Invalid response from server.

Io(String)

I/O error.

Config(String)

Configuration error.

Timeout(String)

Operation timed out.

Cancelled

Operation was cancelled.

Fields

message: String

Human-readable description of the cancellation.

sqlstate: Option<String>

SQLSTATE, typically 57014 (query_canceled).

Closed

The connection was closed.

Fields

message: String

Human-readable description.

sqlstate: Option<String>

SQLSTATE, when the server supplied one.

Conversion(String)

Type conversion error.

FeatureNotSupported(String)

Feature not supported by this connection type.

Other(String)

Other error.

Implementations

impl Error

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

Creates a connection error with no SQLSTATE.

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

Creates an authentication error.

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

Creates a query error with no SQLSTATE, detail, or hint.

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

Creates a protocol error.

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

Creates an I/O error from a message.

Prefer Error::from_io when an io::Error is in hand.

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

Creates a configuration error.

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

Creates a timeout error.

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

Creates a cancellation error with no SQLSTATE.

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

Creates a closed-connection error with no SQLSTATE.

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

Creates a type-conversion error.

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

Creates a “feature not supported” error.

Used when an operation is not available on a particular connection type (e.g. write operations on gRPC connections).

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

Creates a generic “other” error.

pub fn from_io(err: Error) -> Self

Creates an I/O error from an io::Error.

Takes the error by value so it can be used point-free as .map_err(Error::from_io).

pub fn db(severity: &str, code: &str, message: &str) -> Self

Creates an error from a database error response.

pub fn message(&self) -> &str

Returns the error message, without any DETAIL suffix that Display would append.

pub fn detail(&self) -> Option<&str>

Returns the error detail, if available.

pub fn hint(&self) -> Option<&str>

Returns the error hint, if available.

pub fn sqlstate(&self) -> Option<&str>

Extracts the PostgreSQL SQLSTATE code from the error, if present.

SQLSTATE codes are 5-character codes that identify error conditions. See: https://www.postgresql.org/docs/current/errcodes-appendix.html

For Error::Query with no stored code, falls back to scraping the trailing (CODE) that Hyper appends to wire error messages.

Example

use hyperdb_api_core::client::Error;

let err = Error::db("ERROR", "42P04", "database already exists");
assert_eq!(err.sqlstate(), Some("42P04"));

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, __formatter: &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<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.