Struct ExtensionContext

pub struct ExtensionContext<'a> {
    pub schema_env: &'a SchemaEnv,
    pub session_data: &'a Data,
    pub query_data: Option<&'a Data>,
}

Context for extension

Fields

schema_env: &'a SchemaEnv

Schema-scope context data, [Registry], and custom directives.

session_data: &'a Data

Extension-scoped context data shared across all extensions.

Can be accessed only from hooks that implement the Extension trait.

It is created with each new Request and is empty by default.

For subscriptions, the session ends when the subscription is closed.

query_data: Option<&'a Data>

Request-scoped context data shared across all resolvers.

This is a reference to Request::data field. If the request has not initialized yet, the value is seen as None inside the Extension::request, Extension::subscribe, and Extension::prepare_request hooks.

Implementations

impl<'a> ExtensionContext<'a>

pub fn stringify_execute_doc( &self, doc: &ExecutableDocument, variables: &Variables, ) -> String

Convert the specified ExecutableDocument into a query string.

Usually used for log extension, it can hide secret arguments.

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 fn data<D: Any + Send + Sync>(&self) -> Result<&'a D>

Gets the global data defined in the Context or Schema.

If both Schema and Query have the same data type, the data in the Query is obtained.

Errors

Returns a Error if the specified type data does not exist.

pub fn data_unchecked<D: Any + Send + Sync>(&self) -> &'a D

Gets the global data defined in the Context or Schema.

Panics

It will panic if the specified data type does not exist.

pub fn data_opt<D: Any + Send + Sync>(&self) -> Option<&'a D>

Gets the global data defined in the Context or Schema or None if the specified type data does not exist.

Trait Implementations

impl<'a> DataContext<'a> for ExtensionContext<'a>

fn data<D: Any + Send + Sync>(&self) -> Result<&'a D>

Gets the global data defined in the Context or Schema.

fn data_unchecked<D: Any + Send + Sync>(&self) -> &'a D

Gets the global data defined in the Context or Schema.

fn data_opt<D: Any + Send + Sync>(&self) -> Option<&'a D>

Gets the global data defined in the Context or Schema or None if the specified type data does not exist.