Struct Schema

pub struct Schema<'a> { /* private fields */ }

Schema Definition

A schema is created from root types for each kind of operation and is then used against AST documents for validation and execution. In this library the schema is never executable and serves only for metadata and type information. It is hence a “Client Schema”. Reference

Implementations

impl<'a> Schema<'a>

pub fn is_empty(&self) -> bool

Returns whether the schema is a default, empty schema

pub fn query_type(&self) -> Option<&'a SchemaObject<'a>>

Returns the root object type for query operations

pub fn mutation_type(&self) -> Option<&'a SchemaObject<'a>>

Returns the root object type for mutation operations

pub fn subscription_type(&self) -> Option<&'a SchemaObject<'a>>

Returns the root object type for subscription operations

pub fn get_root_type( &self, operation_kind: OperationKind, ) -> Option<&'a SchemaObject<'a>>

Returns the appropriate object type depending on the passed operation kind

pub fn get_type(&self, name: &'a str) -> Option<&'a SchemaType<'a>>

Retrieves a kind by name from known schema types.

pub fn is_sub_type( &self, abstract_type: SchemaType<'a>, sub_type: SchemaType<'a>, ) -> bool

Checks whether a given type is a sub type of another.

This is typically used for return types of fields. A return type may be any given sub type of the return type of said field.

Trait Implementations

impl<'a> Clone for Schema<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Schema<'a>

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

Formats the value using the given formatter.