Struct async_graphql::Schema

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

GraphQL schema

Implementations

impl<Query, Mutation, Subscription> Schema<Query, Mutation, Subscription> where
    Query: ObjectType + Send + Sync + 'static,
    Mutation: ObjectType + Send + Sync + 'static,
    Subscription: SubscriptionType + Send + Sync + '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 async fn execute<'_, '_>(
    &'_ self,
    query_source: &'_ str
) -> Result<QueryResponse>

Execute query without create the QueryBuilder.

pub async fn execute_stream<'_, '_>(
    &'_ self,
    query_source: &'_ str
) -> StreamResponse

Execute the query without create the QueryBuilder, returns a stream, the first result being the query result, followed by the incremental result. Only when there are @defer and @stream directives in the query will there be subsequent incremental results.

pub async fn create_subscription_stream<'_, '_, '_>(
    &'_ self,
    source: &'_ str,
    operation_name: Option<&'_ str>,
    variables: Variables,
    ctx_data: Option<Arc<Data>>
) -> Result<impl Stream<Item = Result<Value>> + Send>

Create subscription stream, typically called inside the SubscriptionTransport::handle_request method

pub fn subscription_connection<T: SubscriptionTransport>(
    &self,
    transport: T
) -> (UnboundedSender<Bytes>, impl Stream<Item = Bytes> + Unpin)

Create subscription connection, returns Sink and Stream.

Trait Implementations

impl<Query, Mutation, Subscription> Clone for Schema<Query, Mutation, Subscription>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Query, Mutation, Subscription> Deref for Schema<Query, Mutation, Subscription> where
    Query: ObjectType + Send + Sync + 'static,
    Mutation: ObjectType + Send + Sync + 'static,
    Subscription: SubscriptionType + Send + Sync + 'static, 

type Target = SchemaInner<Query, Mutation, Subscription>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.