Struct async_graphql::Request

[+] Show declaration

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>,
}

[−] Expand description

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

query: String

[−] Expand description

The query source of the request.

operation_name: Option<String>

[−] Expand description

The operation name of the request.

variables: Variables

[−] Expand description

The variables of the request.

uploads: Vec<UploadValue>

[−] Expand description

Uploads sent with the request.

data: Data

[−] Expand description

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

This data is only valid for this request

extensions: HashMap<String, Value>

[−] Expand description

The extensions config of the request.

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 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[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

fn from(r: Request) -> Self[−]

Performs the conversion.

impl<T: Into<String>> From<T> for Request[+]

[+] Show hidden undocumented items

fn from(query: T) -> Self[−]

Performs the conversion.

impl Serialize for Request[+]

[+] Show hidden undocumented items

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

Serialize this value into the given Serde serializer.