Enum PgWireError 

#[non_exhaustive]
pub enum PgWireError {
    Io(Arc<Error>),
    Protocol(String),
    Server(String),
    Auth(String),
    Tls(String),
    Task(String),
    Internal(String),
    MessageTooLarge {
        payload_bytes: usize,
        limit_bytes: usize,
    },
}

Error type for all pgwire-replication operations.

This enum is #[non_exhaustive]: match on it with a _ arm so that new variants can be added without a breaking release.

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(Arc<Error>)

I/O error (network, file system).

Wraps std::io::Error in an Arc to preserve ErrorKind while keeping PgWireError Clone. Use .kind() via Arc’s Deref.

Protocol(String)

Protocol error - malformed message or unexpected response.

Server(String)

Server error - PostgreSQL returned an error response.

The message typically includes SQLSTATE code.

Auth(String)

Authentication error - wrong credentials or unsupported method.

Tls(String)

TLS error - handshake failure, certificate validation, etc.

Task(String)

Task error - worker panicked or terminated unexpectedly.

Internal(String)

Internal error - bug in the library.

MessageTooLarge

A backend message announced a payload larger than the configured limit, so it was refused before any of it was buffered.

Distinct from Protocol so a caller can tell a legitimate frame over its own max_message_size apart from malformed framing, and report which bound was exceeded without parsing the message text. Non-transient: the refused payload is never consumed, so the connection cannot be resumed.

Fields

payload_bytes: usize

Payload size the server announced, in bytes.

limit_bytes: usize

Limit that refused it, in bytes.

Implementations

impl PgWireError

pub fn is_io(&self) -> bool

Returns true if this is an I/O error.

pub fn is_server(&self) -> bool

Returns true if this is a server error.

pub fn is_auth(&self) -> bool

Returns true if this is an authentication error.

pub fn is_tls(&self) -> bool

Returns true if this is a TLS error.

pub fn is_message_too_large(&self) -> bool

Returns true if this is a message-size error.

pub fn is_transient(&self) -> bool

Returns true if this error is likely transient and retryable.

Transient errors include I/O errors and task errors. Non-transient errors (auth, server, protocol) typically require configuration changes.

Trait Implementations

impl Clone for PgWireError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgWireError

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

Formats the value using the given formatter.

impl Display for PgWireError

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

Formats the value using the given formatter.

impl Error for PgWireError

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 PgWireError

fn from(err: Error) -> Self

Converts to this type from the input type.