Struct SchemaDefinition

pub struct SchemaDefinition { /* private fields */ }

A GraphQL service’s collective type system capabilities are referred to as that service’s “schema”.

SchemaDefinition: Description? schema Directives? { RootOperationTypeDefinition* }

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{SchemaDefinition};
use indoc::indoc;

let mut schema_def = SchemaDefinition::new();
schema_def.query("TryingToFindCatQuery".to_string());
schema_def.mutation("MyMutation".to_string());
schema_def.subscription("MySubscription".to_string());

assert_eq!(
   schema_def.to_string(),
   indoc! { r#"
       schema {
         query: TryingToFindCatQuery
         mutation: MyMutation
         subscription: MySubscription
       }
   "#}
);

Implementations

impl SchemaDefinition

pub fn new() -> Self

Create a new instance of SchemaDef.

pub fn description(&mut self, description: String)

Set the SchemaDef’s description.

pub fn directive(&mut self, directive: Directive)

Add a directive.

pub fn extend(&mut self)

Set as an extension

pub fn query(&mut self, query: String)

Set the schema def’s query type.

pub fn mutation(&mut self, mutation: String)

Set the schema def’s mutation type.

pub fn subscription(&mut self, subscription: String)

Set the schema def’s subscription type.

Trait Implementations

impl Clone for SchemaDefinition

fn clone(&self) -> SchemaDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaDefinition

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

Formats the value using the given formatter.

impl Default for SchemaDefinition

fn default() -> Self

Returns the “default value” for a type.

impl Display for SchemaDefinition

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

Formats the value using the given formatter.

impl TryFrom<SchemaDefinition> for SchemaDefinition

fn try_from(node: SchemaDefinition) -> 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.

impl TryFrom<SchemaExtension> for SchemaDefinition

fn try_from(node: SchemaExtension) -> 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.