Struct QueryError 

pub struct QueryError { /* private fields */ }

Available on crate feature core only.

An error produced by a query or mutation operation.

Implements std::error::Error so it can be used with ? propagation and libraries like anyhow.

The internal message uses Arc<str> so cloning is cheap, making this suitable for high-retry scenarios where the same error is stored in multiple locations.

Example

use gpui_query::QueryError;

let err = QueryError::response("not found");
assert_eq!(err.to_string(), "response error: not found");

Security

Error messages are included in debug/display output and may be serialized. When constructing errors from server responses, sanitize the message first or use QueryError::sanitized.

Implementations

impl QueryError

pub fn new(kind: QueryErrorKind, message: impl Into<Arc<str>>) -> Self

Create a new error with the given kind and message.

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

Create a cancellation error.

pub fn response(message: impl Into<Arc<str>>) -> Self

Create a response error (server-side).

pub fn transport(message: impl Into<Arc<str>>) -> Self

Create a transport error (network, timeout).

pub fn unknown(message: impl Into<Arc<str>>) -> Self

Create an unknown error.

pub fn kind(&self) -> QueryErrorKind

The kind of error.

pub fn message(&self) -> &str

The error message.

pub fn message_arc(&self) -> &Arc<str>

Returns a reference to the inner Arc<str> message, allowing cheap clones of the message without re-allocation.

pub fn sanitized(&self) -> Self

Return a sanitized copy of this error with known sensitive patterns redacted.

Redacts common patterns such as:

• Database connection strings (postgres://..., mysql://...)
• Bearer / token headers (Bearer ..., token=...)
• File paths (/home/..., /Users/..., /etc/...)
• Email-like strings
• Long hex sequences (likely API keys)

Also truncates the message to SANITIZE_MAX_LEN bytes.

Trait Implementations

impl AsRef<Arc<str>> for QueryError

fn as_ref(&self) -> &Arc<str>

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for QueryError

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for QueryError

fn clone(&self) -> QueryError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryError

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for QueryError

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

Formats the value using the given formatter.

impl Eq for QueryError

impl Error for QueryError

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<&str> for QueryError

fn from(value: &str) -> Self

Creates a QueryError with kind QueryErrorKind::Unknown.

See From<String> for rationale on the Unknown mapping.

impl From<String> for QueryError

fn from(value: String) -> Self

Creates a QueryError with kind QueryErrorKind::Unknown.

From<String> and From<&str> always map to Unknown because the original error category cannot be recovered from a plain string. Use QueryError::transport, QueryError::response, or QueryError::cancelled for typed errors.

impl PartialEq for QueryError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QueryError

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryError