Struct apollo_encoder::Document

pub struct Document { /* private fields */ }

The Document type represents a GraphQL document. A GraphQL Document describes a complete file or request string operated on by a GraphQL service or client. A document contains multiple definitions, either executable or representative of a GraphQL type system.

Document: OperationDefinition* FragmentDefinition* SchemaDefinition* ScalarTypeDefinition* ObjectTypeDefinition* InterfaceTypeDefinition* UnionTypeDefinition* EnumTypeDefinition* InputObjectDefinition* DirectiveDefinition*

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{
    Argument, Directive, Document, Field, OperationDefinition, OperationType, Selection, SelectionSet, Type_, Value,
    VariableDefinition,
};
use indoc::indoc;

let mut document = Document::new();
let selection_set = {
    let sels = vec![
        Selection::Field(Field::new(String::from("first"))),
        Selection::Field(Field::new(String::from("second"))),
    ];
    let mut sel_set = SelectionSet::new();
    sels.into_iter().for_each(|sel| sel_set.selection(sel));

    sel_set
};
let var_def = VariableDefinition::new(
    String::from("variable_def"),
    Type_::List {
        ty: Box::new(Type_::NamedType {
            name: String::from("Int"),
        }),
    },
);
let mut new_op = OperationDefinition::new(OperationType::Query, selection_set);
let mut directive = Directive::new(String::from("testDirective"));
directive.arg(Argument::new(
    String::from("first"),
    Value::String("one".to_string()),
));
new_op.variable_definition(var_def);
new_op.directive(directive);

document.operation(new_op);

assert_eq!(
    document.to_string(),
    indoc! { r#"
        query($variable_def: [Int]) @testDirective(first: "one") {
          first
          second
        }
    "#}
);

Implementations

impl Document

pub fn new() -> Self

Create a new instance of Document

pub fn operation(&mut self, operation_definition: OperationDefinition)

Add operation

pub fn fragment(&mut self, fragment_definition: FragmentDefinition)

Add fragment

pub fn schema(&mut self, schema_definition: SchemaDefinition)

Add schema

pub fn scalar(&mut self, scalar_type_definition: ScalarDefinition)

Add scalar

pub fn object(&mut self, object_type_definition: ObjectDefinition)

Add object

pub fn interface(&mut self, interface_type_definition: InterfaceDefinition)

Add interface

pub fn union(&mut self, union_type_definition: UnionDefinition)

Add union

pub fn enum_(&mut self, enum_type_definition: EnumDefinition)

Add enum

pub fn input_object(
    &mut self,
    input_object_type_definition: InputObjectDefinition
)

Add input_object

pub fn directive(&mut self, directive_definition: DirectiveDefinition)

Add directive

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl Display for Document

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

Formats the value using the given formatter.

impl TryFrom<Document> for Document

fn try_from(node: Document) -> Result<Self, Self::Error>

Create an apollo-encoder node from an apollo-parser one.

Errors

This returns an error if the apollo-parser tree is not valid. The error doesn’t have much context due to TryFrom API constraints: validate the parse tree before using TryFrom if granular errors are important to you.

type Error = FromError

The type returned in the event of a conversion error.