Struct Schema 

pub struct Schema { /* private fields */ }

Represents a fully typechecked and immutable GraphQL schema.

Implementations

impl Schema

pub fn all_directives(&self) -> ReadOnlyMap<'_, String, Directive>

Returns a map from DirectiveName (String) -> Directive for all directives (including built-in GraphQL directives) provided by this Schema.

⚠️ NOTE: In addition to directives defined directly in this Schema this map also includes implicitly-defined, built-in directives like Directive::Deprecated, Directive::Include, Directive::Skip, etc.

pub fn all_types(&self) -> ReadOnlyMap<'_, String, GraphQLType>

Returns a map from TypeName (String) -> GraphQLType for all types (including built-in GraphQL types) provided by this Schema.

⚠️ NOTE: In addition to types defined directly in this Schema this map also includes implicitly-defined, built-in types like GraphQLType::Bool, GraphQLType::Float, GraphQLType::ID, etc.

pub fn builder() -> SchemaBuilder

Helper function that just delegates to SchemaBuilder::new().

pub fn defined_directives(&self) -> ReadOnlyMap<'_, String, Directive>

Returns a map from DirectiveName (String) -> Directive for all non-builtin directives defined by this Schema.

⚠️ NOTE: This map does not include any of the built-in directives like Directive::Deprecated, Directive::Include, Directive::Skip, etc. It only includes directives that were defined directly in this Schema.

pub fn defined_types(&self) -> ReadOnlyMap<'_, String, GraphQLType>

Returns a map from TypeName (String) -> GraphQLType for all non-builtin types defined by this Schema.

⚠️ NOTE: This map does not include any of the built-in types like GraphQLType::Bool, GraphQLType::Float, GraphQLType::ID, etc. It only includes types that were defined directly in this Schema.

pub fn mutation_type(&self) -> Option<&GraphQLType>

Returns this Schema’s Mutation root operation type (if one was defined).

⚠️ NOTE: It is strongly recommended that you use Schema::mutation_type() in favor of looking for an ObjectType whose name is "Mutation". GraphQL defines an object type named “Mutation” as the default Mutation type , but it is aslo possible to override this default and use a differently-named ObjectType instead. Schema::mutation_type() factors in any such override and will return the correct ObjectType for this schema.

pub fn query_type(&self) -> &GraphQLType

Returns this Schema’s Query root operation type.

⚠️ NOTE: It is strongly recommended that you use Schema::query_type() in favor of looking for an ObjectType whose name is "Query". GraphQL defines an object type named “Query” as the default Query type, but it is aslo possible to override this default and use a differently-named ObjectType instead. Schema::query_type() factors in any such override and will return the correct ObjectType for this schema.

pub fn subscription_type(&self) -> Option<&GraphQLType>

Returns this Schema’s Subscription root operation type.

⚠️ NOTE: It is strongly recommended that you use Schema::subscription_type() in favor of looking for an ObjectType whose name is "Subscription". GraphQL defines an object type named “Subscription” as the default Subscription type, but it is aslo possible to override this default and use a differently-named ObjectType instead. Schema::subscription_type() factors in any such override and will return the correct ObjectType for this schema.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schema

fn eq(&self, other: &Schema) -> 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 Serialize for Schema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Schema