Struct apollo_parser::Error

pub struct Error { /* private fields */ }

An Error type for operations performed in the lexer and the parser.

Errors get returned alongside the resulting AST if either the lexer or the parser encouter lexical or syntactical errors respectively.

We encourage you to check for the AST’s errors before proceeding to iterate over the AST’s nodes:

Example

use apollo_parser::Parser;

let input = "union SearchResult = Photo | Person | Cat | Dog";
let parser = Parser::new(input);
let ast = parser.parse();

assert_eq!(0, ast.errors().len());

let doc = ast.document();

Diagnostics

Using something like miette crate along with apollo-parser lets you have more visual diagnostics. miette and annotate_snippets examples guide you through integrating them with apollo-parser. These are useful if you are displaying Errors in a terminal-like environment.

Implementations

impl Error

pub fn new<S: Into<String>>(message: S, data: String) -> Self

Create a new instance of Error.

pub fn with_loc<S: Into<String>>(message: S, data: String, index: usize) -> Self

Create a new instance of Error with a Location.

pub fn data(&self) -> &str

Get a reference to the error’s data. This is usually the token that apollo-parser has found to be lexically or syntactically incorrect.

pub fn index(&self) -> usize

Get a reference to the error’s index. This is where the error begins in a given input.

pub fn message(&self) -> &str

Get a reference to the error’s message.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl PartialEq<Error> for Error

fn eq(&self, other: &Error) -> 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 Error

impl StructuralEq for Error

impl StructuralPartialEq for Error