Struct GraphQLError 

pub struct GraphQLError {
    pub message: String,
    pub locations: Option<Vec<GraphQLErrorLocation>>,
    pub path: Option<Vec<Value>>,
    pub extensions: Option<HashMap<String, Value>>,
}

A GraphQL protocol-level error as defined in the GraphQL specification §7.1.2.

This is the canonical wire format used by:

• WebSocket subscription protocol (graphql-ws v5+) error messages
• HTTP GraphQL response errors array
• Federation subgraph HTTP responses

Crates that need HTTP-layer concerns (error codes, status codes, sanitization) build on top of this type rather than replacing it.

Fields

message: String

Human-readable error message.

locations: Option<Vec<GraphQLErrorLocation>>

Locations in the query document where the error occurred.

path: Option<Vec<Value>>

Path into the response data where the error occurred.

Elements are either string field names or integer list indices.

extensions: Option<HashMap<String, Value>>

Arbitrary extension data (error codes, categories, etc.).

Implementations

impl GraphQLError

pub fn new(message: impl Into<String>) -> GraphQLError

Create a simple error with only a message.

pub fn with_code( message: impl Into<String>, code: impl Into<String>, ) -> GraphQLError

Create an error with a string extension code.

This is the conventional way to attach a machine-readable error code:

use fraiseql_error::GraphQLError;

let err = GraphQLError::with_code("Subscription not found", "SUBSCRIPTION_NOT_FOUND");

pub fn with_location(self, line: u32, column: u32) -> GraphQLError

Add a source location to this error.

pub fn with_path(self, path: Vec<Value>) -> GraphQLError

Add a response path to this error.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GraphQLError

fn deserialize<__D>( __deserializer: __D, ) -> Result<GraphQLError, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GraphQLError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.