Struct Document

pub struct Document<'a> {
    pub definitions: Vec<'a, Definition<'a>>,
    pub size_hint: usize,
}

AST Root Node for a GraphQL query language document. This contains one or more definitions of fragments or operations.

Reference

Fields

definitions: Vec<'a, Definition<'a>>

size_hint: usize

A hint on how large the source text was from which this Document was parsed.

This gives an initial indication of the starting capacity of a String that will hold the stringified document.

Implementations

impl<'a, 'b> Document<'a>

pub fn is_empty(&self) -> bool

Checks whether this document contains any definitions.

pub fn fragments( &'a self, ctx: &'a ASTContext, ) -> HashMap<&str, &'a FragmentDefinition<'a>, DefaultHashBuilder, &'a Bump>

Returns a Map keyed by all fragment names mapped to their fragment definitions. This is useful for manually traversing the document and resolving FragmentSpread nodes to their definitions.

pub fn operation( &'a self, by_name: Option<&'b str>, ) -> Result<&'a OperationDefinition<'a>>

Finds an operation definition by name or the single operation contained in the document when None is passed.

Reference

Trait Implementations

impl<'a> Clone for Document<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.

impl<'a> DefaultIn<'a> for Document<'a>

fn default_in(arena: &'a Bump) -> Self

impl<'a> FoldDocument<'a> for Document<'a>

fn fold_operation<'b, F: Folder<'a>>( &'a self, ctx: &'a ASTContext, operation_name: Option<&'a str>, folder: &'b mut F, ) -> Result<&'a Self>

Folds a GraphQL document by a given operation instead. Instead of transforming the given document in its entirety fold_operation will start at the defined operation instead, transforming fragments only as they’re referred to via FragmentSpread nodes. This will create a new document that only refers to and contains the specified operation.

impl<'a> PartialEq for Document<'a>

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

fn write_to_buffer(&self, level: usize, buffer: &mut dyn Write) -> Result

Write an AST node to a buffer implementing the Write trait.

fn print(&self) -> String

Print an AST Node to source text as a String allocated on the heap.

impl<'a> ValidateNode<'a> for Document<'a>

fn validate<Rule: ValidationRule<'a>>( &'a self, ctx: &'a ASTContext, ) -> Result<()>

Run the generic validation rule on the document node and return a result which errors if the validation rule fails on the current document.

impl<'a> StructuralPartialEq for Document<'a>