Struct Document

pub struct Document {
    pub sources: SourceMap,
    pub definitions: Vec<Definition>,
}

AST for a GraphQL Document that can contain executable definitions, type system (schema) definitions, or both.

It is typically parsed from one &str input “file” but can be also be synthesized programatically.

Fields

sources: SourceMap

If this document was originally parsed from a source file, this map contains one entry for that file and its ID.

The document is mutable so it may have been modified since.

definitions: Vec<Definition>

Implementations

impl Document

pub fn new() -> Self

Create an empty document

pub fn parser() -> Parser

Return a new configurable parser

pub fn parse( source_text: impl Into<String>, path: impl AsRef<Path>, ) -> Result<Self, WithErrors<Self>>

Parse input with the default configuration

path is the filesystem path (or arbitrary string) used in diagnostics to identify this source file to users.

pub fn validate_standalone_executable(&self) -> Result<(), DiagnosticList>

Validate as an executable document, as much as possible without a schema

pub fn to_schema(&self) -> Result<Schema, WithErrors<Schema>>

Build a schema with this AST document as its sole input.

pub fn to_schema_validate(&self) -> Result<Valid<Schema>, WithErrors<Schema>>

Build and validate a schema with this AST document as its sole input.

pub fn to_executable( &self, schema: &Valid<Schema>, ) -> Result<ExecutableDocument, WithErrors<ExecutableDocument>>

Build an executable document from this AST, with the given schema

pub fn to_executable_validate( &self, schema: &Valid<Schema>, ) -> Result<Valid<ExecutableDocument>, WithErrors<ExecutableDocument>>

Build and validate an executable document from this AST, with the given schema

pub fn to_mixed_validate( &self, ) -> Result<(Valid<Schema>, Valid<ExecutableDocument>), DiagnosticList>

Build a schema and executable document from this AST containing a mixture of type system definitions and executable definitions, and validate them. This is mostly useful for unit tests.

pub fn serialize(&self) -> Serialize<'_, Self>

Returns a builder that has chaining methods for setting serialization configuration, and implements the Display and ToString traits by writing GraphQL syntax.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Display for Document

Serialize to GraphQL syntax with the default configuration

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

Formats the value using the given formatter.

impl Hash for Document

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Document

source is ignored for comparison

fn eq(&self, other: &Self) -> 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 Eq for Document