Enum Error 

#[non_exhaustive]
pub enum Error {
    Io(Error),
    Protocol(String),
    Server(Box<ServerError>),
    Auth(String),
    Tls(String),
    Pool(String),
    Config(String),
    Encode(String),
    Decode(String),
    ColumnNotFound(String),
    ColumnIndex {
        index: usize,
        count: usize,
    },
    UnexpectedNull(usize),
    Timeout(String),
    ConnectionClosed,
    Copy(String),
    TransactionCompleted,
    AllHostsFailed(String),
    WrongSessionAttrs(String),
}

All possible errors returned by sentinel-driver.

Stability contract

This enum is #[non_exhaustive] as of v1.1.0. New variants may be added in any future minor release without a major version bump, in line with the additive-only stability policy in GOVERNANCE.md.

What this means for downstream code:

• ? propagation and From/Into conversion are unaffected.
• Manual exhaustive match arms must include a wildcard _ => arm to keep compiling against future minor releases. This is the only migration required by the v1.0 → v1.1 transition.

// OK — has a wildcard arm.
match err {
    Error::ConnectionClosed => /* ... */,
    Error::TransactionCompleted => /* ... */,
    _ => /* ... */,
}

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.

Io(Error)

I/O error from TCP/TLS stream.

Protocol(String)

PostgreSQL protocol error (unexpected message, malformed packet, etc.).

Server(Box<ServerError>)

Error returned by the PostgreSQL server.

Auth(String)

Authentication failure.

Tls(String)

TLS/SSL negotiation error.

Pool(String)

Connection pool error.

Config(String)

Invalid configuration.

Encode(String)

Type encoding error (Rust → PG).

Decode(String)

Type decoding error (PG → Rust).

ColumnNotFound(String)

Column not found by name.

ColumnIndex

Column index out of bounds.

Fields

index: usize

count: usize

UnexpectedNull(usize)

Unexpected null value.

Timeout(String)

Timeout (connect, query, pool checkout).

ConnectionClosed

Connection is closed or broken.

Copy(String)

COPY protocol error.

TransactionCompleted

Transaction already completed (committed or rolled back).

AllHostsFailed(String)

All configured hosts failed to connect.

WrongSessionAttrs(String)

Connected server does not match required session attributes.

Implementations

impl Error

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

Returns the SQLSTATE code if this is a server error.

pub fn server_error(&self) -> Option<&ServerError>

Returns the server error details if this is a server error.

pub fn is_unique_violation(&self) -> bool

Returns true if this error represents a unique violation (SQLSTATE 23505).

pub fn is_foreign_key_violation(&self) -> bool

Returns true if this error represents a foreign key violation (SQLSTATE 23503).

pub fn is_fatal(&self) -> bool

Returns true if the connection should be considered broken.

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(source: Error) -> Self

Converts to this type from the input type.