Struct async_graphql::Request

#[non_exhaustive]
pub struct Request {
    pub query: String,
    pub operation_name: Option<String>,
    pub variables: Variables,
    pub uploads: Vec<UploadValue>,
    pub data: Data,
    pub extensions: HashMap<String, Value>,
    pub introspection_mode: IntrospectionMode,
    /* private fields */
}

GraphQL request.

This can be deserialized from a structure of the query string, the operation name and the variables. The names are all in camelCase (e.g. operationName).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query: String

The query source of the request.

operation_name: Option<String>

The operation name of the request.

variables: Variables

The variables of the request.

uploads: Vec<UploadValue>

Uploads sent with the request.

data: Data

The data of the request that can be accessed through Context::data.

This data is only valid for this request

extensions: HashMap<String, Value>

The extensions config of the request.

introspection_mode: IntrospectionMode

Sets the introspection mode for this request (defaults to IntrospectionMode::Enabled).

Implementations

impl Request

pub fn new(query: impl Into<String>) -> Self

Create a request object with query source.

pub fn operation_name<T: Into<String>>(self, name: T) -> Self

Specify the operation name of the request.

pub fn variables(self, variables: Variables) -> Self

Specify the variables.

pub fn data<D: Any + Send + Sync>(self, data: D) -> Self

Insert some data for this request.

pub fn disable_introspection(self) -> Self

Disable introspection queries for this request.

pub fn only_introspection(self) -> Self

Only allow introspection queries for this request.

pub fn parsed_query(&mut self) -> Result<&ExecutableDocument, ServerError>

Performs parsing of query ahead of execution.

This effectively allows to inspect query information, before passing request to schema for execution as long as query is valid.

pub fn set_upload(&mut self, var_path: &str, upload: UploadValue)

Set a variable to an upload value.

var_path is a dot-separated path to the item that begins with variables, for example variables.files.2.content is equivalent to the Rust code request.variables["files"][2]["content"]. If no variable exists at the path this function won’t do anything.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

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

Deserialize this value from the given Serde deserializer.

impl From<Request> for BatchRequest

fn from(r: Request) -> Self

Converts to this type from the input type.

impl<T: Into<String>> From<T> for Request

fn from(query: T) -> Self

Converts to this type from the input type.

impl Serialize for Request

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

Serialize this value into the given Serde serializer.