Enum FraiseQLError 

#[non_exhaustive]
pub enum FraiseQLError {
    Parse {
        message: String,
        location: String,
    },
    Validation {
        message: String,
        path: Option<String>,
    },
    UnknownField {
        field: String,
        type_name: String,
    },
    UnknownType {
        type_name: String,
    },
    Database {
        message: String,
        sql_state: Option<String>,
    },
    ConnectionPool {
        message: String,
    },
    Timeout {
        timeout_ms: u64,
        query: Option<String>,
    },
    Cancelled {
        query_id: String,
        reason: String,
    },
    Authorization {
        message: String,
        action: Option<String>,
        resource: Option<String>,
    },
    Authentication {
        message: String,
    },
    RateLimited {
        message: String,
        retry_after_secs: u64,
    },
    NotFound {
        resource_type: String,
        identifier: String,
    },
    Conflict {
        message: String,
    },
    Configuration {
        message: String,
    },
    Internal {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
}

Main error type for FraiseQL operations.

All errors in the core library are converted to this type. Language bindings convert this to their native error types.

Stability

This enum is marked #[non_exhaustive] to allow adding new error variants in future minor versions without breaking backward compatibility.

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.

Parse

GraphQL parsing error.

Returned when the GraphQL query string cannot be parsed.

Fields

message: String

Error message describing the parse failure.

location: String

Location in the query where the error occurred.

Validation

GraphQL validation error.

Returned when a query is syntactically valid but semantically invalid.

Fields

message: String

Error message describing the validation failure.

path: Option<String>

Path to the field with the error (e.g., “user.posts.0.title”).

UnknownField

Unknown field error.

Returned when a query references a field that doesn’t exist in the schema.

Fields

field: String

The field name that was not found.

type_name: String

The type on which the field was queried.

UnknownType

Unknown type error.

Returned when a query references a type that doesn’t exist in the schema.

Fields

type_name: String

The type name that was not found.

Database

Database operation error.

Wraps errors from PostgreSQL operations.

Fields

message: String

Error message from the database.

sql_state: Option<String>

SQL state code if available (e.g., “23505” for unique violation).

ConnectionPool

Connection pool error.

Returned when the database connection pool is exhausted or unavailable.

Fields

message: String

Error message.

Timeout

Query timeout error.

Returned when a database query exceeds the configured timeout.

Fields

timeout_ms: u64

Timeout duration in milliseconds.

query: Option<String>

The query that timed out (truncated if too long).

Cancelled

Query cancellation error.

Returned when a query execution is cancelled via a cancellation token or similar mechanism (e.g., client disconnection, explicit user request).

Fields

query_id: String

Query identifier for tracking/logging.

reason: String

Reason for cancellation (e.g., “user cancelled”, “connection closed”).

Authorization

Authorization error.

Returned when the user doesn’t have permission for an operation.

Fields

message: String

Error message.

action: Option<String>

The action that was denied (e.g., “read”, “write”, “delete”).

resource: Option<String>

The resource that was being accessed.

Authentication

Authentication error.

Returned when authentication fails (invalid token, expired, etc.).

Fields

message: String

Error message.

RateLimited

Rate limiting error.

Returned when a request is rate limited due to too many errors.

Fields

message: String

Error message.

retry_after_secs: u64

Number of seconds to wait before retrying.

NotFound

Resource not found error.

Returned when a requested resource doesn’t exist.

Fields

resource_type: String

Type of resource (e.g., “User”, “Post”).

identifier: String

Identifier that was looked up.

Conflict

Conflict error.

Returned when an operation would conflict with existing data.

Fields

message: String

Error message.

Configuration

Configuration error.

Returned when configuration is invalid or missing.

Fields

message: String

Error message.

Internal

Internal error.

Returned for unexpected internal errors. Should be rare.

Fields

message: String

Error message.

source: Option<Box<dyn Error + Send + Sync>>

Optional source error for debugging.

Implementations

impl FraiseQLError

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

Create a parse error.

pub fn parse_at(message: impl Into<String>, location: impl Into<String>) -> Self

Create a parse error with location.

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

Create a validation error.

pub fn validation_at( message: impl Into<String>, path: impl Into<String>, ) -> Self

Create a validation error with path.

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

Create a database error.

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

Create an authorization error.

pub fn not_found( resource_type: impl Into<String>, identifier: impl Into<String>, ) -> Self

Create a not found error.

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

Create a configuration error.

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

Create an internal error.

pub fn cancelled(query_id: impl Into<String>, reason: impl Into<String>) -> Self

Create a cancellation error.

pub const fn is_client_error(&self) -> bool

Check if this is a client error (4xx equivalent).

pub const fn is_server_error(&self) -> bool

Check if this is a server error (5xx equivalent).

pub const fn is_retryable(&self) -> bool

Check if this error is retryable.

pub const fn status_code(&self) -> u16

Get HTTP status code equivalent.

pub const fn error_code(&self) -> &'static str

Get error code for GraphQL response.

Trait Implementations

impl Debug for FraiseQLError

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

Formats the value using the given formatter.

impl Display for FraiseQLError

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

Formats the value using the given formatter.

impl Error for FraiseQLError

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 FraiseQLError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FraiseQLError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<VarError> for FraiseQLError

fn from(e: VarError) -> Self

Converts to this type from the input type.