thegraph-graphql-http 0.4.1

A rust implementation of the GraphQL-over-HTTP spec for The Graph network services
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use crate::graphql::{Document, IntoDocumentWithVariables};

/// The media type for GraphQL-over-HTTP requests. As specified in the section
/// [4.1 Media Types](https://graphql.github.io/graphql-over-http/draft/#sec-Media-Types)
/// of the GraphQL-over-HTTP specification.
pub const GRAPHQL_REQUEST_MEDIA_TYPE: &str = "application/json";

/// The parameters of a GraphQL-over-HTTP request.
///
/// As specified in the section [5.1 Request Parameters](https://graphql.github.io/graphql-over-http/draft/#sec-Request-Parameters)
/// of the GraphQL-over-HTTP specification.
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize)]
pub struct RequestParameters {
    /// The string representation of the Source Text of a GraphQL Document as specified in [the
    /// Language section of the GraphQL specification](https://spec.graphql.org/draft/#sec-Language).
    pub query: Document,

    /// Optional name of the operation in the Document to execute.
    #[serde(rename = "operationName", skip_serializing_if = "Option::is_none")]
    pub operation_name: Option<String>,

    /// Values for any Variables defined by the Operation.
    #[serde(skip_serializing_if = "serde_json::Map::is_empty")]
    pub variables: serde_json::Map<String, serde_json::Value>,

    /// Reserved for implementors to extend the protocol however they see fit.
    #[serde(skip_serializing_if = "serde_json::Map::is_empty")]
    pub extensions: serde_json::Map<String, serde_json::Value>,
}

/// Convert `self` into a `RequestParameters` struct.
pub trait IntoRequestParameters {
    /// Consumes `self` and returns a `RequestParameters` struct.
    fn into_request_parameters(self) -> RequestParameters;
}

impl IntoRequestParameters for RequestParameters {
    #[inline]
    fn into_request_parameters(self) -> RequestParameters {
        self
    }
}

// Any type implementing `IntoDocumentWithVariables` (or `IntoDocument`) can be converted into
// `RequestParameters`.
impl<T> IntoRequestParameters for T
where
    T: IntoDocumentWithVariables,
{
    fn into_request_parameters(self) -> RequestParameters {
        let (query, variables) = self.into_document_with_variables();

        // Do not send the `variables` field if the json serialization fails, or if the
        // serialization result is not a JSON object.
        let variables = match serde_json::to_value(variables) {
            Ok(serde_json::Value::Object(vars)) => Some(vars),
            _ => None,
        };

        RequestParameters {
            query,
            operation_name: None,
            variables: variables.unwrap_or_default(),
            extensions: Default::default(),
        }
    }
}