pub struct GraphQLRequest<S = DefaultScalarValue>where
    S: ScalarValue,
{ /* private fields */ }
Expand description

The expected structure of the decoded JSON document for either POST or GET requests.

For POST, you can use Serde to deserialize the incoming JSON data directly into this struct - it derives Deserialize for exactly this reason.

For GET, you will need to parse the query string and extract “query”, “operationName”, and “variables” manually.

Implementations§

source§

impl<S> GraphQLRequest<S>where
    S: ScalarValue,

source

pub fn operation_name(&self) -> Option<&str>

Returns the operation_name associated with this request.

source

pub fn new(
    query: String,
    operation_name: Option<String>,
    variables: Option<InputValue<S>>
) -> Self

Construct a new GraphQL request from parts

source

pub fn execute_sync<'a, QueryT, MutationT, SubscriptionT>(
    &'a self,
    root_node: &'a RootNode<'_, QueryT, MutationT, SubscriptionT, S>,
    context: &QueryT::Context
) -> GraphQLResponse<'a, S>where
    S: ScalarValue,
    QueryT: GraphQLType<S>,
    MutationT: GraphQLType<S, Context = QueryT::Context>,
    SubscriptionT: GraphQLType<S, Context = QueryT::Context>,

Execute a GraphQL request synchronously using the specified schema and context

This is a simple wrapper around the execute_sync function exposed at the top level of this crate.

source

pub async fn execute<'a, QueryT, MutationT, SubscriptionT>(
    &'a self,
    root_node: &'a RootNode<'a, QueryT, MutationT, SubscriptionT, S>,
    context: &'a QueryT::Context
) -> GraphQLResponse<'a, S>where
    QueryT: GraphQLTypeAsync<S>,
    QueryT::TypeInfo: Sync,
    QueryT::Context: Sync,
    MutationT: GraphQLTypeAsync<S, Context = QueryT::Context>,
    MutationT::TypeInfo: Sync,
    SubscriptionT: GraphQLType<S, Context = QueryT::Context> + Sync,
    SubscriptionT::TypeInfo: Sync,
    S: ScalarValue + Send + Sync,

Execute a GraphQL request using the specified schema and context

This is a simple wrapper around the execute function exposed at the top level of this crate.

Trait Implementations§

source§

impl<S> Clone for GraphQLRequest<S>where
    S: ScalarValue + Clone,

source§

fn clone(&self) -> GraphQLRequest<S>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<S> Debug for GraphQLRequest<S>where
    S: ScalarValue + Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'de, S> Deserialize<'de> for GraphQLRequest<S>where
    S: ScalarValue,
    InputValue<S>: Deserialize<'de> + Serialize,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<S> PartialEq<GraphQLRequest<S>> for GraphQLRequest<S>where
    S: ScalarValue + PartialEq,

source§

fn eq(&self, other: &GraphQLRequest<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<S> Serialize for GraphQLRequest<S>where
    S: ScalarValue + Serialize,

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<S> StructuralPartialEq for GraphQLRequest<S>where
    S: ScalarValue,

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for GraphQLRequest<S>where
    S: RefUnwindSafe,

§

impl<S> Send for GraphQLRequest<S>where
    S: Send,

§

impl<S> Sync for GraphQLRequest<S>where
    S: Sync,

§

impl<S> Unpin for GraphQLRequest<S>where
    S: Unpin,

§

impl<S> UnwindSafe for GraphQLRequest<S>where
    S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere
    T: for<'de> Deserialize<'de>,