Struct async_graphql::Schema

[+] Show declaration

pub struct Schema<Query, Mutation, Subscription>(_);

[−] Expand description

GraphQL schema.

Cloning a schema is cheap, so it can be easily shared.

Implementations

impl<Query, Mutation, Subscription> Schema<Query, Mutation, Subscription> where
    Query: ObjectType + 'static,
    Mutation: ObjectType + 'static,
    Subscription: SubscriptionType + 'static, [−]

pub fn build(
    query: Query,
    mutation: Mutation,
    subscription: Subscription
) -> SchemaBuilder<Query, Mutation, Subscription>[−]

Create a schema builder

The root object for the query and Mutation needs to be specified. If there is no mutation, you can use EmptyMutation. If there is no subscription, you can use EmptySubscription.

pub fn new(
    query: Query,
    mutation: Mutation,
    subscription: Subscription
) -> Schema<Query, Mutation, Subscription>[−]

Create a schema

pub fn sdl(&self) -> String[−]

Returns SDL(Schema Definition Language) of this schema.

pub fn federation_sdl(&self) -> String[−]

Returns Federation SDL(Schema Definition Language) of this schema.

pub fn names(&self) -> Vec<String>[−]

Get all names in this schema

Maybe you want to serialize a custom binary protocol. In order to minimize message size, a dictionary is usually used to compress type names, field names, directive names, and parameter names. This function gets all the names, so you can create this dictionary.

pub async fn execute(&self, request: impl Into<Request>) -> Response[−]

Execute a GraphQL query.

pub async fn execute_batch(&self, batch_request: BatchRequest) -> BatchResponse[−]

Execute a GraphQL batch query.

pub fn execute_stream(
    &self,
    request: impl Into<Request>
) -> impl Stream<Item = Response> + Send[−]

Execute a GraphQL subscription.

Trait Implementations

impl<Query, Mutation, Subscription> Clone for Schema<Query, Mutation, Subscription>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<Query, Mutation, Subscription> Default for Schema<Query, Mutation, Subscription> where
    Query: Default + ObjectType + 'static,
    Mutation: Default + ObjectType + 'static,
    Subscription: Default + SubscriptionType + 'static, [+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the “default value” for a type.

impl<Query, Mutation, Subscription> Deref for Schema<Query, Mutation, Subscription>[+]

[+] Show hidden undocumented items

type Target = SchemaInner<Query, Mutation, Subscription>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target[−]

Dereferences the value.