Struct Executor

pub struct Executor<'r, 'a, CtxT, S = DefaultScalarValue>
where
    CtxT: 'a,
    S: 'a,
{ /* private fields */ }

Query execution engine

The executor helps drive the query execution in a schema. It keeps track of the current field stack, context, variables, and errors.

Implementations

impl<'r, 'a, CtxT, S> Executor<'r, 'a, CtxT, S>

where S: ScalarValue,

pub async fn resolve_into_stream<'i, 'v, 'res, T>( &'r self, info: &'i T::TypeInfo, value: &'v T, ) -> Value<ValuesStream<'res, S>>

where T: GraphQLSubscriptionValue<S, Context = CtxT> + ?Sized, T::TypeInfo: Sync, CtxT: Sync, S: Send + Sync, 'i: 'res, 'v: 'res, 'a: 'res,

Resolve a single arbitrary value into a stream of Values. If a field fails to resolve, pushes error to Executor and returns Value::Null.

pub async fn subscribe<'s, 't, 'res, T>( &'r self, info: &'t T::TypeInfo, value: &'t T, ) -> Result<Value<ValuesStream<'res, S>>, FieldError<S>>

where T: GraphQLSubscriptionValue<S, Context = CtxT> + ?Sized, T::TypeInfo: Sync, CtxT: Sync, S: Send + Sync, 't: 'res, 'a: 'res,

Resolve a single arbitrary value into a stream of Values. Calls resolve_into_stream on T.

pub fn resolve_with_ctx<NewCtxT, T>( &self, info: &T::TypeInfo, value: &T, ) -> ExecutionResult<S>

where NewCtxT: FromContext<CtxT>, T: GraphQLValue<S, Context = NewCtxT> + ?Sized,

Resolve a single arbitrary value, mapping the context to a new type

pub fn resolve<T>(&self, info: &T::TypeInfo, value: &T) -> ExecutionResult<S>

where T: GraphQLValue<S, Context = CtxT> + ?Sized,

Resolve a single arbitrary value into an ExecutionResult

pub async fn resolve_async<T>( &self, info: &T::TypeInfo, value: &T, ) -> ExecutionResult<S>

where T: GraphQLValueAsync<S, Context = CtxT> + ?Sized, T::TypeInfo: Sync, CtxT: Sync, S: Send + Sync,

Resolve a single arbitrary value into an ExecutionResult

pub async fn resolve_with_ctx_async<NewCtxT, T>( &self, info: &T::TypeInfo, value: &T, ) -> ExecutionResult<S>

where T: GraphQLValueAsync<S, Context = NewCtxT> + ?Sized, T::TypeInfo: Sync, NewCtxT: FromContext<CtxT> + Sync, S: Send + Sync,

Resolve a single arbitrary value, mapping the context to a new type

pub fn resolve_into_value<T>(&self, info: &T::TypeInfo, value: &T) -> Value<S>

where T: GraphQLValue<S, Context = CtxT>,

Resolve a single arbitrary value into a return value

If the field fails to resolve, null will be returned.

pub async fn resolve_into_value_async<T>( &self, info: &T::TypeInfo, value: &T, ) -> Value<S>

where T: GraphQLValueAsync<S, Context = CtxT> + ?Sized, T::TypeInfo: Sync, CtxT: Sync, S: Send + Sync,

Resolve a single arbitrary value into a return value

If the field fails to resolve, null will be returned.

pub fn replaced_context<'b, NewCtxT>( &'b self, ctx: &'b NewCtxT, ) -> Executor<'b, 'b, NewCtxT, S>

Derive a new executor by replacing the context

This can be used to connect different types, e.g. from different Rust libraries, that require different context types.

pub fn context(&self) -> &'r CtxT

Access the current context

You usually provide the context when calling the top-level execute function, or using the context factory.

pub fn schema(&self) -> &'a SchemaType<'_, S>

The currently executing schema

pub fn location(&self) -> &SourcePosition

The current location of the executor

pub fn push_error(&self, error: FieldError<S>)

Add an error to the execution engine at the current executor location

pub fn push_error_at(&self, error: FieldError<S>, location: SourcePosition)

Add an error to the execution engine at a specific location

pub fn new_error(&self, error: FieldError<S>) -> ExecutionError<S>

Returns new ExecutionError at current location

pub fn look_ahead(&'a self) -> LookAheadSelection<'a, S>

Construct a lookahead selection for the current selection.

This allows seeing the whole selection and perform operations affecting the children.

pub fn as_owned_executor(&self) -> OwnedExecutor<'a, CtxT, S>

Create new OwnedExecutor and clone all current data (except for errors) there

New empty vector is created for errors because existing errors won’t be needed to be accessed by user in OwnedExecutor as existing errors will be returned in execute_query/execute_mutation/resolve_into_stream/etc.