Struct GraphQLError 

pub struct GraphQLError {
    pub message: String,
    pub code: ErrorCode,
    pub locations: Option<Vec<ErrorLocation>>,
    pub path: Option<Vec<String>>,
    pub extensions: Option<ErrorExtensions>,
}

GraphQL error following spec.

Fields

message: String

Error message.

code: ErrorCode

Error code for client handling.

locations: Option<Vec<ErrorLocation>>

Location in query where error occurred.

path: Option<Vec<String>>

Path to field that caused error.

extensions: Option<ErrorExtensions>

Additional error information.

Implementations

impl GraphQLError

pub fn new(message: impl Into<String>, code: ErrorCode) -> Self

Create a new GraphQL error.

pub fn with_location(self, line: usize, column: usize) -> Self

Add location to error.

pub fn with_path(self, path: Vec<String>) -> Self

Add path to error.

pub fn with_extensions(self, extensions: ErrorExtensions) -> Self

Add extensions to error.

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Add request ID for distributed tracing.

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

Validation error.

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

Parse error with hint for common syntax issues.

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

Request error with validation details.

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

Database error - includes connection, timeout, and query errors.

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

Internal server error - unexpected conditions.

pub fn unauthenticated() -> Self

Unauthenticated error - authentication token is missing or invalid.

pub fn forbidden() -> Self

Forbidden error - user lacks permission to access resource.

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

Not found error - requested resource does not exist.

pub fn timeout(operation: impl Into<String>) -> Self

Timeout error - operation took too long and was cancelled.

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

Rate limit error - too many requests from client.

pub fn from_fraiseql_error(err: &FraiseQLError) -> Self

Construct a typed GraphQLError from a fraiseql_core::error::FraiseQLError executor error.

Maps specific core error variants to their closest HTTP-semantic equivalent, preserving type information for correct client handling and sanitizer routing.

pub fn persisted_query_not_found() -> Self

Persisted query not found — client must re-send the full query body.

pub fn persisted_query_mismatch() -> Self

Persisted query hash mismatch — SHA-256 of body does not match the provided hash.

pub fn forbidden_query() -> Self

Raw query forbidden — trusted documents strict mode requires a documentId.

pub fn document_not_found(doc_id: impl Into<String>) -> Self

Document not found — the provided documentId is not in the trusted manifest.

pub fn circuit_breaker_open(entity: &str, retry_after_secs: u64) -> Self

Circuit breaker open — federation entity temporarily unavailable.

The response will carry a Retry-After header set to retry_after_secs.

Trait Implementations

impl Clone for GraphQLError

fn clone(&self) -> GraphQLError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphQLError

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

Formats the value using the given formatter.

impl From<GraphQLError> for ErrorResponse

fn from(error: GraphQLError) -> Self

Converts to this type from the input type.

impl Serialize for GraphQLError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.