Struct Error 

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

An error that occurred when using the QuestDB client library.

The payload lives behind a Box so Result<T, Error> stays pointer-sized on the happy path: the optional query-side ServerInfo and the diagnostic strings would otherwise push the struct past the clippy::result_large_err threshold.

Implementations

impl Error

pub fn new<S: Into<String>>(code: ErrorCode, msg: S) -> Error

Create an error with the given code and message.

pub fn in_doubt(&self) -> bool

true when the operation that produced this error is delivery-unknown (“in doubt”): the current input may already have reached the server, so blindly replaying it on a fresh connection can duplicate rows.

This is independent of the code: a delivery-unknown failure typically reports ErrorCode::FailoverRetry (the connection can be replaced), yet FailoverRetry alone does not mean the input is safe to retry. Use in_doubt() == false together with a retryable code to decide whether re-sending the same input is safe; when in_doubt() is true, only replay if table-level dedup/upsert keys make duplicates harmless.

pub fn with_qwp_ws_rejection(self, rejection: QwpWsSenderError) -> Self

Attach a structured QWP/WebSocket rejection to this error.

pub fn with_upgrade_reject(self, reject: UpgradeReject) -> Self

Builder: attach a query-side UpgradeReject (HTTP 421 + X-QuestDB-Role or SERVER_INFO target mismatch) so the host-health tracker can read the role + zone without re-parsing.

pub fn with_server_info(self, info: ServerInfo) -> Self

Builder: attach the full last-observed SERVER_INFO to a RoleMismatch produced from the SERVER_INFO target-mismatch path.

pub fn code(&self) -> ErrorCode

Get the error code (category) of this error.

pub fn msg(&self) -> &str

Get the string message of this error.

pub fn qwp_ws_rejection(&self) -> Option<&QwpWsSenderError>

Return the structured QWP/WebSocket rejection that made this error terminal, if one is available.

pub fn upgrade_reject(&self) -> Option<&UpgradeReject>

Server-advertised role + zone carried alongside a query-side error. Some when the error originated from an HTTP 421 + X-QuestDB-Role upgrade reject or a SERVER_INFO role / target= filter mismatch; None for all other failure paths.

pub fn server_info(&self) -> Option<&ServerInfo>

Full last-observed SERVER_INFO carried alongside this error. Some only when the rejection came from the SERVER_INFO target-mismatch path; None everywhere else. Lets callers distinguish “no endpoint matched target=” (this is Some) from “all endpoints unreachable” (this is None).

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

fn from(_: Infallible) -> 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