Struct SchemaBuilder

pub struct SchemaBuilder { /* private fields */ }

Available on crate feature dynamic-schema only.

Dynamic schema builder

Implementations

impl SchemaBuilder

pub fn register(self, ty: impl Into<Type>) -> Self

Register a GraphQL type

pub fn enable_uploading(self) -> Self

Enable uploading files (register Upload type).

pub fn data<D: Any + Send + Sync>(self, data: D) -> Self

Add a global data that can be accessed in the Schema. You access it with Context::data.

pub fn extension(self, extension: impl ExtensionFactory) -> Self

Add an extension to the schema.

pub fn limit_complexity(self, complexity: usize) -> Self

Set the maximum complexity a query can have. By default, there is no limit.

pub fn limit_depth(self, depth: usize) -> Self

Set the maximum depth a query can have. By default, there is no limit.

pub fn limit_recursive_depth(self, depth: usize) -> Self

Set the maximum recursive depth a query can have. (default: 32)

If the value is too large, stack overflow may occur, usually 32 is enough.

pub fn limit_directives(self, max_directives: usize) -> Self

Set the maximum number of directives on a single field. (default: no limit)

pub fn validation_mode(self, validation_mode: ValidationMode) -> Self

Set the validation mode, default is ValidationMode::Strict.

pub fn disable_suggestions(self) -> Self

Disable field suggestions.

pub fn disable_introspection(self) -> Self

Disable introspection queries.

pub fn introspection_only(self) -> Self

Only process introspection queries, everything else is processed as an error.

pub fn enable_federation(self) -> Self

Enable federation, which is automatically enabled if the Query has least one entity definition.

pub fn entity_resolver<F>(self, resolver_fn: F) -> Self

where F: for<'a> Fn(ResolverContext<'a>) -> FieldFuture<'a> + Send + Sync + 'static,

Set the entity resolver for federation

pub fn finish(self) -> Result<Schema, SchemaError>

Consumes this builder and returns a schema.