Struct apollo_router::graphql::Request

#[non_exhaustive]
pub struct Request {
    pub query: Option<String>,
    pub operation_name: Option<String>,
    pub variables: Map<ByteString, Value>,
    pub extensions: Map<ByteString, Value>,
}

A GraphQL Request used to represent both supergraph and subgraph requests.

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: Option<String>

The GraphQL operation (e.g., query, mutation) string.

For historical purposes, the term “query” is commonly used to refer to any GraphQL operation which might be, e.g., a mutation.

operation_name: Option<String>

The (optional) GraphQL operation name.

When specified, this name must match the name of an operation in the GraphQL document. When excluded, there must exist only a single operation in the GraphQL document. Typically, this value is provided as the operationName on an HTTP-sourced GraphQL request.

variables: Map<ByteString, Value>

The (optional) GraphQL variables in the form of a JSON object.

When specified, these variables can be referred to in the query by using $variableName syntax, where {"variableName": "value"} has been specified as this variables value.

extensions: Map<ByteString, Value>

The (optional) GraphQL extensions of a GraphQL request.

The implementations of extensions are server specific and not specified by the GraphQL specification. For example, Apollo projects support Automated Persisted Queries which are specified in the extensions of a request by populating the persistedQuery key within the extensions object:

{
  "query": "...",
  "variables": { /* ... */ },
  "extensions": {
    "persistedQuery": {
      "version": 1,
      "sha256Hash": "sha256HashOfQuery"
.   }
  }
}

Implementations

impl Request

pub fn deserialize_from_bytes(data: &Bytes) -> Result<Self, Error>

Deserialize as JSON from &Bytes, avoiding string copies where possible

pub fn from_urlencoded_query( url_encoded_query: String ) -> Result<Request, Error>

Convert encoded URL query string parameters (also known as “search params”) into a GraphQL Request.

An error will be produced in the event that the query string parameters cannot be turned into a valid GraphQL Request.

impl Request

pub fn builder( ) -> __RequestBuilder<(__Optional<Option<String>>, __Optional<Option<String>>, __Optional<Map<ByteString, Value>>, __Optional<Map<ByteString, Value>>)>

This is the constructor (or builder) to use when constructing a GraphQL Request.

The optionality of parameters on this constructor match the runtime requirements which are necessary to create a valid GraphQL Request. (This contrasts against the fake_new constructor which may be more tolerant to missing properties which are only necessary for testing purposes. If you are writing tests, you may want to use Self::fake_new().)

impl Request

pub fn fake_builder( ) -> __RequestBuilder<(__Optional<Option<String>>, __Optional<Option<String>>, __Optional<Map<ByteString, Value>>, __Optional<Map<ByteString, Value>>)>

This is the constructor (or builder) to use when constructing a fake GraphQL Request. Use Self::new() to construct a real request.

This is offered for testing purposes and it relaxes the requirements of some parameters to be specified that would be otherwise required for a real request. It’s usually enough for most testing purposes, especially when a fully constructed Request is difficult to construct. While today, its paramters have the same optionality as its new counterpart, that may change in future versions.

Trait Implementations

impl AsRef<Request> for Arc<Request<Request>>

fn as_ref(&self) -> &Request

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

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 Hash for Request

fn hash<__H>(&self, __state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Request

fn eq(&self, other: &Self) -> bool

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

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.

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.

impl Eq for Request