Struct apollo_compiler::executable::ExecutableDocument

pub struct ExecutableDocument {
    pub sources: SourceMap,
    pub anonymous_operation: Option<Node<Operation>>,
    pub named_operations: IndexMap<Name, Node<Operation>>,
    pub fragments: IndexMap<Name, Node<Fragment>>,
}

Executable definitions, annotated with type information

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 may have been modified since.

anonymous_operation: Option<Node<Operation>>

named_operations: IndexMap<Name, Node<Operation>>

fragments: IndexMap<Name, Node<Fragment>>

Implementations

impl ExecutableDocument

pub fn new() -> Self

Create an empty document, to be filled programatically

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

Parse an executable document with the default configuration.

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

Create a Parser to use different parser configuration.

pub fn parse_and_validate( schema: &Valid<Schema>, source_text: impl Into<String>, path: impl AsRef<Path>, ) -> Result<Valid<Self>, WithErrors<Self>>

parse then validate, to get a Valid<ExecutableDocument> when mutating it isn’t needed.

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

pub fn all_operations(&self) -> impl Iterator<Item = &Node<Operation>>

Returns an iterator of operations, both anonymous and named

pub fn get_operation( &self, name_request: Option<&str>, ) -> Result<&Node<Operation>, GetOperationError>

Return the relevant operation for a request, or a request error

This the GetOperation() algorithm in the Executing Requests section of the specification.

A GraphQL request comes with a document (which may contain multiple operations) an an optional operation name. When a name is given the request executes the operation with that name, which is expected to exist. When it is not given / null / None, the document is expected to contain a single operation (which may or may not be named) to avoid ambiguity.

pub fn get_operation_mut( &mut self, name_request: Option<&str>, ) -> Result<&mut Operation, GetOperationError>

Similar to get_operation but returns a mutable reference.

pub fn insert_operation( &mut self, operation: impl Into<Node<Operation>>, ) -> Option<Node<Operation>>

Insert the given operation in either named_operations or anonymous_operation as appropriate, and return the old operation (if any) with that name (or lack thereof).

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 ExecutableDocument

fn clone(&self) -> ExecutableDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutableDocument

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

Formats the value using the given formatter.

impl Default for ExecutableDocument

fn default() -> ExecutableDocument

Returns the “default value” for a type.

impl Display for ExecutableDocument

Serialize to GraphQL syntax with the default configuration

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

Formats the value using the given formatter.

impl PartialEq for ExecutableDocument

sources and build_errors are ignored for comparison

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