Struct async_graphql::dynamic::Schema

pub struct Schema(_);

Available on crate feature dynamic-schema only.

Dyanmic GraphQL schema.

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

Implementations

impl Schema

pub fn build(
    query: &str,
    mutation: Option<&str>,
    subscription: Option<&str>
) -> SchemaBuilder

Create a schema builder

pub fn sdl(&self) -> String

Returns SDL(Schema Definition Language) of this schema.

pub fn sdl_with_options(&self, options: SDLExportOptions) -> String

Returns SDL(Schema Definition Language) of this schema with options.

pub async fn execute(&self, request: impl Into<DynamicRequest>) -> Response

Execute a GraphQL query.

Examples found in repository

src/dynamic/schema.rs (line 434)

    async fn execute(&self, request: Request) -> Response {
        Schema::execute(self, request).await
    }

pub fn execute_stream_with_session_data(
    &self,
    request: impl Into<DynamicRequest>,
    session_data: Arc<Data>
) -> impl Stream<Item = Response> + Send + Unpin

Execute a GraphQL subscription with session data.

Examples found in repository

src/dynamic/schema.rs (line 427)

    pub fn execute_stream(
        &self,
        request: impl Into<DynamicRequest>,
    ) -> impl Stream<Item = Response> + Send + Unpin {
        self.execute_stream_with_session_data(request, Default::default())
    }
}

#[async_trait::async_trait]
impl Executor for Schema {
    async fn execute(&self, request: Request) -> Response {
        Schema::execute(self, request).await
    }

    fn execute_stream(
        &self,
        request: Request,
        session_data: Option<Arc<Data>>,
    ) -> BoxStream<'static, Response> {
        Schema::execute_stream_with_session_data(self, request, session_data.unwrap_or_default())
            .boxed()
    }

pub fn execute_stream(
    &self,
    request: impl Into<DynamicRequest>
) -> impl Stream<Item = Response> + Send + Unpin

Execute a GraphQL subscription.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a copy 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 Executor for Schema

fn execute<'life0, 'async_trait>(
    &'life0 self,
    request: Request
) -> Pin<Box<dyn Future<Output = Response> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Execute a GraphQL query.

fn execute_stream(
    &self,
    request: Request,
    session_data: Option<Arc<Data>>
) -> BoxStream<'static, Response>

Execute a GraphQL subscription with session data.

fn execute_batch<'life0, 'async_trait>(
    &'life0 self,
    batch_request: BatchRequest
) -> Pin<Box<dyn Future<Output = BatchResponse> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Execute a GraphQL batch query.