Struct GraphQLParser 

pub struct GraphQLParser<'src, TTokenSource: GraphQLTokenSource<'src>> { /* private fields */ }

A recursive descent parser for GraphQL documents.

Generic over the token source, enabling parsing from both string input (StrGraphQLTokenSource) and proc-macro input (RustMacroGraphQLTokenSource).

Usage

use libgraphql_parser::ast;
use libgraphql_parser::GraphQLParser;

let source = "type Query { hello: String }";
let parser = GraphQLParser::new(source);
let result = parser.parse_schema_document();

assert!(result.is_ok());
if let Some(doc) = result.valid_ast() {
    assert!(matches!(
        doc.definitions[0],
        ast::schema::Definition::TypeDefinition(_),
    ));
}

Implementations

impl<'src> GraphQLParser<'src, StrGraphQLTokenSource<'src>>

pub fn new<S: AsRef<str> + ?Sized>(source: &'src S) -> Self

Creates a new parser from a string-like source.

Accepts any type that can be referenced as a str, including &str, &String, and &Cow<str>.

Example

use libgraphql_parser::GraphQLParser;

let source = "type Query { hello: String }";
let parser = GraphQLParser::new(source);
let result = parser.parse_schema_document();
assert!(result.is_ok());

impl<'src, TTokenSource: GraphQLTokenSource<'src>> GraphQLParser<'src, TTokenSource>

pub fn from_token_source(token_source: TTokenSource) -> Self

Creates a new parser from a token source.

pub fn parse_schema_document(self) -> ParseResult<Document>

Parses a schema document (type system definitions only).

pub fn parse_executable_document(self) -> ParseResult<Document>

Parses an executable document (operations and fragments only).

pub fn parse_mixed_document(self) -> ParseResult<MixedDocument>

Parses a mixed document (both type system and executable definitions).