Struct GraphQLParseError 

pub struct GraphQLParseError { /* private fields */ }

A parse error with location information and contextual notes.

This structure provides comprehensive error information for both human-readable CLI output and programmatic handling by tools.

Implementations

impl GraphQLParseError

pub fn new( message: impl Into<String>, span: GraphQLSourceSpan, kind: GraphQLParseErrorKind, ) -> Self

Creates a new parse error with no notes.

pub fn with_notes( message: impl Into<String>, span: GraphQLSourceSpan, kind: GraphQLParseErrorKind, notes: GraphQLErrorNotes, ) -> Self

Creates a new parse error with notes.

pub fn from_lexer_error( message: impl Into<String>, span: GraphQLSourceSpan, lexer_notes: GraphQLErrorNotes, ) -> Self

Creates a parse error from a lexer error token.

When the parser encounters a GraphQLTokenKind::Error token, this method converts it to a GraphQLParseError, preserving the lexer’s message and notes.

pub fn message(&self) -> &str

Returns the human-readable error message.

pub fn span(&self) -> &GraphQLSourceSpan

Returns the primary span where the error was detected.

pub fn kind(&self) -> &GraphQLParseErrorKind

Returns the categorized error kind.

pub fn notes(&self) -> &GraphQLErrorNotes

Returns the additional notes for this error.

pub fn add_note(&mut self, message: impl Into<String>)

Adds a general note without a span.

pub fn add_note_with_span( &mut self, message: impl Into<String>, span: GraphQLSourceSpan, )

Adds a general note with a span (pointing to a related location).

pub fn add_help(&mut self, message: impl Into<String>)

Adds a help note without a span.

pub fn add_help_with_span( &mut self, message: impl Into<String>, span: GraphQLSourceSpan, )

Adds a help note with a span.

pub fn add_spec(&mut self, url: impl Into<String>)

Adds a spec reference note.

pub fn format_detailed(&self, source: Option<&str>) -> String

Formats this error as a diagnostic string for CLI output.

Produces output like:

error: Expected `:` after field name
  --> schema.graphql:5:12
   |
 5 |     userName String
   |              ^^^^^^ expected `:`
   |
   = note: Field definitions require `:` between name and type
   = help: Did you mean: `userName: String`?

Arguments

• source: Optional source text for snippet extraction. If None, snippets are omitted but line/column info is still shown.

pub fn format_oneline(&self) -> String

Formats this error as a single-line summary.

Produces output like:

schema.graphql:5:12: error: Expected `:` after field name

Trait Implementations

impl Clone for GraphQLParseError

fn clone(&self) -> GraphQLParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphQLParseError

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

Formats the value using the given formatter.

impl Display for GraphQLParseError

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

Formats the value using the given formatter.

impl Error for GraphQLParseError

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.