Struct apollo_parser::SyntaxTree

pub struct SyntaxTree { /* private fields */ }

An AST generated by the parser. Consists of a syntax tree and a Vec<Error> if any.

Example

Given a syntactically incorrect token uasdf21230jkdw which cannot be part of any of GraphQL definitions and a syntactically correct SelectionSet, we are able to see both the AST for the SelectionSet and the error with an incorrect token.

use apollo_parser::Parser;

let schema = r#"
uasdf21230jkdw

{
  pet
  faveSnack
}
"#;
let parser = Parser::new(schema);

let ast = parser.parse();
// The Vec<Error> that's part of the SyntaxTree struct.
assert_eq!(ast.errors().len(), 1);

// The AST with Document as its root node.
let doc = ast.document();
let nodes: Vec<_> = doc.definitions().into_iter().collect();
assert_eq!(nodes.len(), 1);

Implementations

impl SyntaxTree

pub fn errors(&self) -> Iter<'_, Error>

Get a reference to the syntax tree’s errors.

pub fn recursion_limit(&self) -> LimitTracker

Get the syntax tree’s recursion limit.

pub fn token_limit(&self) -> LimitTracker

Get the syntax tree’s token limit.

pub fn green(&self) -> GreenNode

pub fn document(self) -> Document

Return the root typed Document node.

Trait Implementations

impl Clone for SyntaxTree

fn clone(&self) -> SyntaxTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxTree

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

Formats the value using the given formatter.

impl PartialEq<SyntaxTree> for SyntaxTree

fn eq(&self, other: &SyntaxTree) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SyntaxTree

impl StructuralEq for SyntaxTree

impl StructuralPartialEq for SyntaxTree