Struct apollo_compiler::ApolloCompiler

pub struct ApolloCompiler {
    pub db: Database,
}

Fields

db: Database

Implementations

impl ApolloCompiler

Apollo compiler creates a context around your GraphQL. It creates refernces between various GraphQL types in scope.

Example

use apollo_compiler::ApolloCompiler;

let input = r#"
  interface Pet {
    name: String
  }

  type Dog implements Pet {
    name: String
    nickname: String
    barkVolume: Int
  }

  type Cat implements Pet {
    name: String
    nickname: String
    meowVolume: Int
  }

  union CatOrDog = Cat | Dog

  type Human {
    name: String
    pets: [Pet]
  }

  type Query {
    human: Human
  }
"#;

let ctx = ApolloCompiler::new(input);
let diagnostics = ctx.validate();
for diagnostic in &diagnostics {
    // this will pretty-print diagnostics using the miette crate.
    println!("{}", diagnostic);
}
assert!(diagnostics.is_empty());

pub fn new(input: &str) -> Self

Create a new instance of Apollo Compiler.

pub fn parse(&self) -> Arc<SyntaxTree>

Get access to the apollo-parser's AST.

pub fn validate(&self) -> Vec<ApolloDiagnostic>

Validate your GraphQL input. Returns Diagnostics that you can pretty-print.

Example

use apollo_compiler::ApolloCompiler;
let input = r#"
type Query {
  website: URL,
  amount: Int
}
"#;

let ctx = ApolloCompiler::new(input);
let diagnostics = ctx.validate();
for diagnostic in &diagnostics {
    println!("{}", diagnostic);
}
assert_eq!(diagnostics.len(), 1);

pub fn syntax_errors(&self) -> Vec<ApolloDiagnostic>

Get access to syntax errors returned by apollo-parser.

pub fn definitions(&self) -> Arc<Vec<Definition>>

Get access to all definitions in a document.

pub fn operations(&self) -> Arc<Vec<OperationDefinition>>

Get access to all operations in a document.

pub fn fragments(&self) -> Arc<Vec<FragmentDefinition>>

Get access to all fragments in a document.

pub fn schema(&self) -> Arc<SchemaDefinition>

Get access to the schema definition in a document.

pub fn object_types(&self) -> Arc<Vec<ObjectTypeDefinition>>

Get access to all object type definitions in a document.

pub fn scalars(&self) -> Arc<Vec<ScalarTypeDefinition>>

Get access to all scalar type definitions in a document. The compiler adds built-in scalars(Int, String, Float, Boolean, ID) in addition to custom scalars found in input.

pub fn enums(&self) -> Arc<Vec<EnumTypeDefinition>>

Get access to all enum type definitions in a document.

pub fn unions(&self) -> Arc<Vec<UnionTypeDefinition>>

Get access to all union type definitions in a document.

pub fn directive_definitions(&self) -> Arc<Vec<DirectiveDefinition>>

Get access to all directive type definitions in a document. The compiler will add all built-in directives (specifiedBy, skip, deprecated, include) in addition to all custom directives in input.

pub fn input_objects(&self) -> Arc<Vec<InputObjectTypeDefinition>>

Get access to all input object type definitions in a document.