pub struct Executor<'r, 'a, CtxT, S = DefaultScalarValue>where
CtxT: 'a,
S: 'a,{ /* private fields */ }Expand description
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§
Source§impl<'r, 'a, CtxT, S> Executor<'r, 'a, CtxT, S>where
S: ScalarValue,
impl<'r, 'a, CtxT, S> Executor<'r, 'a, CtxT, S>where
S: ScalarValue,
Sourcepub async fn resolve_into_stream<'i, 'v, 'res, T>(
&'r self,
info: &'i T::TypeInfo,
value: &'v T,
) -> Value<ValuesStream<'res, S>>
pub async fn resolve_into_stream<'i, 'v, 'res, T>( &'r self, info: &'i T::TypeInfo, value: &'v T, ) -> Value<ValuesStream<'res, S>>
Resolve a single arbitrary value into a stream of Values.
If a field fails to resolve, pushes error to Executor
and returns Value::Null.
Sourcepub async fn subscribe<'s, 't, 'res, T>(
&'r self,
info: &'t T::TypeInfo,
value: &'t T,
) -> Result<Value<ValuesStream<'res, S>>, FieldError<S>>
pub async fn subscribe<'s, 't, 'res, T>( &'r self, info: &'t T::TypeInfo, value: &'t T, ) -> Result<Value<ValuesStream<'res, S>>, FieldError<S>>
Resolve a single arbitrary value into a stream of Values.
Calls resolve_into_stream on T.
Sourcepub fn resolve_with_ctx<NewCtxT, T>(
&self,
info: &T::TypeInfo,
value: &T,
) -> ExecutionResult<S>
pub fn resolve_with_ctx<NewCtxT, T>( &self, info: &T::TypeInfo, value: &T, ) -> ExecutionResult<S>
Resolve a single arbitrary value, mapping the context to a new type
Sourcepub fn resolve<T>(&self, info: &T::TypeInfo, value: &T) -> ExecutionResult<S>where
T: GraphQLValue<S, Context = CtxT> + ?Sized,
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
Sourcepub async fn resolve_async<T>(
&self,
info: &T::TypeInfo,
value: &T,
) -> ExecutionResult<S>
pub async fn resolve_async<T>( &self, info: &T::TypeInfo, value: &T, ) -> ExecutionResult<S>
Resolve a single arbitrary value into an ExecutionResult
Sourcepub 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,
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
Sourcepub fn resolve_into_value<T>(&self, info: &T::TypeInfo, value: &T) -> Value<S>where
T: GraphQLValue<S, Context = CtxT>,
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.
Sourcepub async fn resolve_into_value_async<T>(
&self,
info: &T::TypeInfo,
value: &T,
) -> Value<S>
pub async fn resolve_into_value_async<T>( &self, info: &T::TypeInfo, value: &T, ) -> Value<S>
Resolve a single arbitrary value into a return value
If the field fails to resolve, null will be returned.
Sourcepub fn replaced_context<'b, NewCtxT>(
&'b self,
ctx: &'b NewCtxT,
) -> Executor<'b, 'b, NewCtxT, S>
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.
Sourcepub fn context(&self) -> &'r CtxT
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.
Sourcepub fn schema(&self) -> &'a SchemaType<S>
pub fn schema(&self) -> &'a SchemaType<S>
The currently executing schema
Sourcepub fn location(&self) -> &SourcePosition
pub fn location(&self) -> &SourcePosition
The current location of the executor
Sourcepub fn push_error(&self, error: FieldError<S>)
pub fn push_error(&self, error: FieldError<S>)
Add an error to the execution engine at the current executor location
Sourcepub fn push_error_at(&self, error: FieldError<S>, location: SourcePosition)
pub fn push_error_at(&self, error: FieldError<S>, location: SourcePosition)
Add an error to the execution engine at a specific location
Sourcepub fn new_error(&self, error: FieldError<S>) -> ExecutionError<S>
pub fn new_error(&self, error: FieldError<S>) -> ExecutionError<S>
Returns new ExecutionError at current location
Sourcepub fn look_ahead(&'a self) -> LookAheadSelection<'a, S>
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.
Sourcepub fn as_owned_executor(&self) -> OwnedExecutor<'a, CtxT, S>
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.
Auto Trait Implementations§
impl<'r, 'a, CtxT, S> Freeze for Executor<'r, 'a, CtxT, S>
impl<'r, 'a, CtxT, S> RefUnwindSafe for Executor<'r, 'a, CtxT, S>where
CtxT: RefUnwindSafe,
S: RefUnwindSafe,
impl<'r, 'a, CtxT, S> Send for Executor<'r, 'a, CtxT, S>
impl<'r, 'a, CtxT, S> Sync for Executor<'r, 'a, CtxT, S>
impl<'r, 'a, CtxT, S> Unpin for Executor<'r, 'a, CtxT, S>
impl<'r, 'a, CtxT, S> UnwindSafe for Executor<'r, 'a, CtxT, S>where
CtxT: RefUnwindSafe,
S: RefUnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.