cynic 3.3.0

A code first GraphQL client for Rust
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

//! Types & traits for working with GraphQL Variables

use std::marker::PhantomData;

/// The type of a variable
#[derive(Debug, Clone, Copy)]
pub enum VariableType {
    /// A list of some VariableType
    List(&'static VariableType),
    /// Some VariableType that may be null
    Nullable(&'static VariableType),
    /// A type with the given name
    Named(&'static str),
}

/// Allows a struct to be used as variables in a GraphQL query.
///
/// Users should not implement this themselves, and should use the
/// `QueryVariables` derive.  All the fields on a `QueryVariables` struct should
/// be available as variables in the query, using `$variable_name` notation.
pub trait QueryVariables {
    /// A struct that determines which variables are available when using this
    /// struct.
    type Fields: QueryVariablesFields;
    /// An associated constant that contains the variable names & their types.
    ///
    /// This is used to construct the query string we send to a server.
    const VARIABLES: &'static [(&'static str, VariableType)];
}

/// Represents a set of named fields that are required for a query
pub trait QueryVariablesFields {}

impl QueryVariables for () {
    type Fields = ();
    const VARIABLES: &'static [(&'static str, VariableType)] = &[];
}
impl QueryVariablesFields for () {}

#[doc(hidden)]
/// A VariableDefinition.
///
/// These are returned by functions on the `Fields` associated type of a
/// `QueryVariables` struct.  But users shouldn't need to care about that.
pub struct VariableDefinition<Variables, Type> {
    pub name: &'static str,
    phantom: PhantomData<fn() -> (Variables, Type)>,
}

impl<Variables, Type> VariableDefinition<Variables, Type> {
    /// Create a new variable with the given name.
    pub fn new(name: &'static str) -> Self {
        VariableDefinition {
            name,
            phantom: PhantomData,
        }
    }
}