Struct Document 

pub struct Document<'src> {
    pub definitions: Vec<Definition<'src>>,
    pub span: ByteSpan,
    pub syntax: Option<Box<DocumentSyntax<'src>>>,
}

Root AST node for any GraphQL document.

A document contains a list of Definitions which may be type-system definitions, type-system extensions, or executable definitions (operations and fragments).

The spec’s Document grammar production allows both executable and type-system definitions to coexist:

Document : Definition+
Definition :
    ExecutableDefinition |
    TypeSystemDefinitionOrExtension

However, more constrained document types exist for specific use cases: ExecutableDocument (operations and fragments only) and TypeSystemDocument (type-system definitions only). The spec mandates that a document submitted for execution must contain only executable definitions — but parsing is a separate concern from execution.

This AST uses a single unified Document type that can represent any of these document forms. This is useful because a parser library serves many tools beyond just execution services: schema linters, formatters, code generators, IDE language servers, and document merge/federation tools all benefit from being able to parse any valid GraphQL syntax without rejecting it at the parse level. Validation of which definition kinds are permitted is left to downstream consumers (e.g. an execution engine rejecting type-system definitions). The convenience methods schema_definitions() and executable_definitions() provide easy filtering when needed.

See Document in the spec.

Fields

definitions: Vec<Definition<'src>>

span: ByteSpan

syntax: Option<Box<DocumentSyntax<'src>>>

Implementations

impl<'src> Document<'src>

pub fn executable_definitions(&self) -> impl Iterator<Item = &Definition<'src>>

Iterate over only the executable definitions (operations and fragments) in this document.

pub fn schema_definitions(&self) -> impl Iterator<Item = &Definition<'src>>

Iterate over only the type-system definitions and extensions in this document.

pub fn trailing_trivia(&self) -> Option<&[GraphQLTriviaToken<'src>]>

Returns the trailing trivia tokens (whitespace, comments) that appear after the last definition in the document, if syntax detail was captured.

impl Document<'_>

pub fn append_source(&self, sink: &mut String, source: Option<&str>)

See AstNode::append_source().

pub fn byte_span(&self) -> ByteSpan

Returns this document’s byte-offset span within the source text.

The returned ByteSpan can be resolved to line/column positions via source_span() or ByteSpan::resolve().

pub fn source_span(&self, source_map: &SourceMap<'_>) -> Option<SourceSpan>

Resolves this document’s position to line/column coordinates using the given SourceMap.

Returns None if the byte offsets cannot be resolved (e.g. the span was synthetically constructed without valid position data).

Trait Implementations

impl AstNode for Document<'_>

fn append_source(&self, sink: &mut String, source: Option<&str>)

See AstNode::append_source().

fn byte_span(&self) -> ByteSpan

Returns this document’s byte-offset span within the source text.

The returned ByteSpan can be resolved to line/column positions via source_span() or ByteSpan::resolve().

fn source_span(&self, source_map: &SourceMap<'_>) -> Option<SourceSpan>

Resolves this document’s position to line/column coordinates using the given SourceMap.

Returns None if the byte offsets cannot be resolved (e.g. the span was synthetically constructed without valid position data).

fn to_source(&self, source: Option<&str>) -> String

Return this node as a source string.

impl<'src> Clone for Document<'src>

fn clone(&self) -> Document<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for Document<'src>

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

Formats the value using the given formatter.

impl<'src> PartialEq for Document<'src>

fn eq(&self, other: &Document<'src>) -> 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<'src> StructuralPartialEq for Document<'src>