cynic/operation/
builder.rs

1use std::{borrow::Cow, collections::HashSet, marker::PhantomData};
2
3use crate::{
4    queries::{build_executable_document, OperationType},
5    schema::{MutationRoot, QueryRoot, SubscriptionRoot},
6    QueryFragment, QueryVariableLiterals, QueryVariables,
7};
8
9use super::Operation;
10
11/// Low level builder for [Operation].
12///
13/// Users should prefer to use [crate::QueryBuilder], [crate::MutationBuilder] or
14/// [crate::SubscriptionBuilder] where possible, unless they need the control offered by
15/// this builder.
16pub struct OperationBuilder<QueryFragment, Variables = ()> {
17    variables: Option<Variables>,
18    operation_kind: OperationType,
19    operation_name: Option<Cow<'static, str>>,
20    features: HashSet<String>,
21    phantom: PhantomData<fn() -> QueryFragment>,
22}
23
24impl<Fragment, Variables> OperationBuilder<Fragment, Variables>
25where
26    Fragment: QueryFragment,
27    Variables: QueryVariables,
28{
29    fn new(operation_kind: OperationType) -> Self {
30        OperationBuilder {
31            variables: None,
32            operation_kind,
33            operation_name: Fragment::name(),
34            features: HashSet::new(),
35            phantom: PhantomData,
36        }
37    }
38
39    /// Creates an `OperationBuilder` for a query operation
40    pub fn query() -> Self
41    where
42        Fragment::SchemaType: QueryRoot,
43    {
44        Self::new(OperationType::Query)
45    }
46
47    /// Creates an `OperationBuilder` for a mutation operation
48    pub fn mutation() -> Self
49    where
50        Fragment::SchemaType: MutationRoot,
51    {
52        Self::new(OperationType::Mutation)
53    }
54
55    /// Creates an `OperationBuilder` for a subscription operation
56    pub fn subscription() -> Self
57    where
58        Fragment::SchemaType: SubscriptionRoot,
59    {
60        Self::new(OperationType::Subscription)
61    }
62
63    /// Adds variables for the operation
64    pub fn with_variables(self, variables: Variables) -> Self {
65        Self {
66            variables: Some(variables),
67            ..self
68        }
69    }
70
71    /// Sets variables for the operation
72    pub fn set_variables(&mut self, variables: Variables) {
73        self.variables = Some(variables);
74    }
75
76    /// Enables a feature for the operation
77    pub fn with_feature_enabled(mut self, feature: &str) -> Self {
78        self.enable_feature(feature);
79        self
80    }
81
82    /// Sets an enabled feature for the operation
83    pub fn enable_feature(&mut self, feature: &str) {
84        self.features.insert(feature.to_string());
85    }
86
87    /// Adds a name to the operation
88    pub fn with_operation_name(self, name: &str) -> Self {
89        OperationBuilder {
90            operation_name: Some(Cow::Owned(name.to_string())),
91            ..self
92        }
93    }
94
95    /// Sets a name for the operation
96    pub fn set_operation_name(&mut self, name: &str) {
97        self.operation_name = Some(Cow::Owned(name.to_string()));
98    }
99
100    /// Tries to build an [Operation]
101    pub fn build(self) -> Result<super::Operation<Fragment, Variables>, OperationBuildError> {
102        Ok(Operation {
103            query: build_executable_document::<Fragment, Variables>(
104                self.operation_kind,
105                self.operation_name.as_deref(),
106                self.features.clone(),
107                None,
108            ),
109            variables: self.variables.ok_or(OperationBuildError::VariablesNotSet)?,
110            operation_name: self.operation_name,
111            phantom: PhantomData,
112        })
113    }
114
115    /// Builds an Operation with all of the current variables inlined into the executable document
116    /// as arguments.
117    ///
118    /// You should derive `QueryVariableLiterals` on your `QueryArguments` struct to use this
119    /// functionality.
120    pub fn build_with_variables_inlined(
121        self,
122    ) -> Result<super::Operation<Fragment, ()>, OperationBuildError>
123    where
124        Variables: QueryVariableLiterals,
125    {
126        let variables = self.variables.ok_or(OperationBuildError::VariablesNotSet)?;
127        Ok(Operation {
128            query: build_executable_document::<Fragment, Variables>(
129                self.operation_kind,
130                self.operation_name.as_deref(),
131                self.features.clone(),
132                Some(&variables),
133            ),
134            variables: (),
135            operation_name: self.operation_name,
136            phantom: PhantomData,
137        })
138    }
139}
140
141#[derive(thiserror::Error, Debug)]
142/// Errors that can occur when building the operation
143pub enum OperationBuildError {
144    #[error("You need to call with_variables or set_variables before calling build")]
145    /// Error for when `set_variables` or `with_variables` was not called
146    VariablesNotSet,
147    #[error("Couldn't format the query into a string: {0}")]
148    /// Error when a write! call that builds the query string failed
149    CouldntBuildQueryString(#[from] std::fmt::Error),
150}
cynic/operation/builder.rs

cynic/operation/
builder.rs
