Enum GraphQLTokenKind 

pub enum GraphQLTokenKind<'src> {
    Ampersand,
    At,
    Bang,
    Colon,
    CurlyBraceClose,
    CurlyBraceOpen,
    Dollar,
    Ellipsis,
    Equals,
    ParenClose,
    ParenOpen,
    Pipe,
    SquareBracketClose,
    SquareBracketOpen,
    Name(Cow<'src, str>),
    IntValue(Cow<'src, str>),
    FloatValue(Cow<'src, str>),
    StringValue(Cow<'src, str>),
    True,
    False,
    Null,
    Eof,
    Error {
        message: String,
        error_notes: GraphQLErrorNotes,
    },
}

The kind of a GraphQL token.

Literal values (IntValue, FloatValue, StringValue) store only the raw source text.

Lifetime Parameter

The 'src lifetime enables zero-copy lexing: StrGraphQLTokenSource can borrow string slices directly from the source text using Cow::Borrowed, while RustMacroGraphQLTokenSource uses Cow::Owned since proc_macro2 doesn’t expose contiguous source text.

Negative Numeric Literals

Negative numbers like -123 are lexed as single tokens (e.g. IntValue("-123")), not as separate minus and number tokens. This matches the GraphQL spec’s grammar for IntValue/FloatValue.

Variants

Ampersand

&

At

@

Bang

!

Colon

:

CurlyBraceClose

}

CurlyBraceOpen

{

Dollar

$

Ellipsis

...

Equals

=

ParenClose

)

ParenOpen

(

Pipe

|

SquareBracketClose

]

SquareBracketOpen

[

Name(Cow<'src, str>)

A GraphQL name/identifier.

Uses Cow<'src, str> to enable zero-copy lexing from string sources.

IntValue(Cow<'src, str>)

Raw source text of an integer literal, including optional negative sign (e.g. "-123", "0").

Use parse_int_value() to parse the raw text into an i64. Uses Cow<'src, str> to enable zero-copy lexing from string sources.

FloatValue(Cow<'src, str>)

Raw source text of a float literal, including optional negative sign (e.g. "-1.23e-4", "0.5").

Use parse_float_value() to parse the raw text into an f64. Uses Cow<'src, str> to enable zero-copy lexing from string sources.

StringValue(Cow<'src, str>)

Raw source text of a string literal, including quotes (e.g. "\"hello\\nworld\"", "\"\"\"block\"\"\"")

Use parse_string_value() to process escape sequences and get the unescaped content. Uses Cow<'src, str> to enable zero-copy lexing from string sources.

True

The true literal.

False

The false literal.

Null

The null literal.

Eof

End of input. The associated GraphQLToken may carry trailing trivia.

Error

A lexer error. This allows the parser to continue and collect multiple errors in a single pass.

TODO: Explore replacing error_notes with a richer diagnostics structure that includes things like severity level and “fix action” for IDE integration.

Fields

message: String

A human-readable error message.

error_notes: GraphQLErrorNotes

Optional notes providing additional context or suggestions.

Implementations

impl<'src> GraphQLTokenKind<'src>

pub fn name_borrowed(s: &'src str) -> Self

Create a Name token from a borrowed string slice (zero-copy).

Use this in StrGraphQLTokenSource where the source text can be borrowed directly.

pub fn name_owned(s: String) -> Self

Create a Name token from an owned String.

Use this in RustMacroGraphQLTokenSource where the string must be allocated (e.g., from ident.to_string()).

pub fn int_value_borrowed(s: &'src str) -> Self

Create an IntValue token from a borrowed string slice (zero-copy).

pub fn int_value_owned(s: String) -> Self

Create an IntValue token from an owned String.

pub fn float_value_borrowed(s: &'src str) -> Self

Create a FloatValue token from a borrowed string slice (zero-copy).

pub fn float_value_owned(s: String) -> Self

Create a FloatValue token from an owned String.

pub fn string_value_borrowed(s: &'src str) -> Self

Create a StringValue token from a borrowed string slice (zero-copy).

pub fn string_value_owned(s: String) -> Self

Create a StringValue token from an owned String.

pub fn error(message: impl Into<String>, error_notes: GraphQLErrorNotes) -> Self

Create an Error token.

Error messages are always dynamically constructed, so they use plain String rather than Cow.

pub fn is_punctuator(&self) -> bool

Returns true if this token is a punctuator.

pub fn as_punctuator_str(&self) -> Option<&'static str>

Returns the string representation of this token if it is a punctuator.

pub fn is_value(&self) -> bool

Returns true if this token is a value literal (IntValue, FloatValue, StringValue, True, False, or Null).

pub fn is_error(&self) -> bool

Returns true if this token represents a lexer error.

pub fn parse_int_value(&self) -> Option<Result<i64, ParseIntError>>

Parse an IntValue’s raw text to i64.

Returns None if this is not an IntValue, or Some(Err(...)) if parsing fails.

pub fn parse_float_value(&self) -> Option<Result<f64, ParseFloatError>>

Parse a FloatValue’s raw text to f64.

Returns None if this is not a FloatValue, or Some(Err(...)) if parsing fails.

pub fn parse_string_value( &self, ) -> Option<Result<String, GraphQLStringParsingError>>

Parse a StringValue’s raw text to unescaped content.

Handles escape sequences per the GraphQL spec:

• For single-line strings ("..."): processes \n, \r, \t, \\, \", \/, \b, \f, \uXXXX (fixed 4-digit), and \u{X...} (variable length).
• For block strings ("""..."""): applies the indentation stripping algorithm per spec, then processes \""" escape only.

Returns None if this is not a StringValue, or Some(Err(...)) if parsing fails.

Trait Implementations

impl<'src> Clone for GraphQLTokenKind<'src>

fn clone(&self) -> GraphQLTokenKind<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for GraphQLTokenKind<'src>

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

Formats the value using the given formatter.

impl<'src> PartialEq for GraphQLTokenKind<'src>

fn eq(&self, other: &GraphQLTokenKind<'src>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'src> StructuralPartialEq for GraphQLTokenKind<'src>