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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
mod connection_type; mod edge; mod page_info; mod slice; use crate::{Context, ObjectType, QueryError, Result}; pub use connection_type::Connection; /// Connection query operation pub enum QueryOperation<'a> { /// Forward query Forward { /// After this cursor after: Option<&'a str>, /// How many records did this query return limit: usize, }, /// Backward query Backward { /// Before this cursor before: Option<&'a str>, /// How many records did this query return limit: usize, }, } /// Empty edge extension object pub struct EmptyEdgeFields; #[async_graphql_derive::Object(internal)] impl EmptyEdgeFields {} /// Data source of GraphQL Cursor Connections type /// /// `Edge` is an extension object type that extends the edge fields, If you don't need it, you can use `EmptyEdgeFields`. /// /// # References /// (GraphQL Cursor Connections Specification)[https://facebook.github.io/relay/graphql/connections.htm] /// /// # Examples /// /// ```rust /// use async_graphql::*; /// use byteorder::{ReadBytesExt, BE}; /// /// struct QueryRoot; /// /// struct DiffFields(i32); /// /// #[Object] /// impl DiffFields { /// #[field] /// async fn diff(&self) -> i32 { /// self.0 /// } /// } /// /// struct Numbers; /// /// #[async_trait::async_trait] /// impl DataSource for Numbers { /// type Element = i32; /// type EdgeFieldsObj = DiffFields; /// /// async fn query_operation(&self, operation: &QueryOperation<'_>) -> Result<Connection<Self::Element, Self::EdgeFieldsObj>> { /// let (start, end) = match operation { /// QueryOperation::Forward {after, limit} => { /// let start = after.and_then(|after| base64::decode(after).ok()) /// .and_then(|data| data.as_slice().read_i32::<BE>().ok()) /// .map(|idx| idx + 1) /// .unwrap_or(0); /// let end = start + *limit as i32; /// (start, end) /// } /// QueryOperation::Backward {before, limit} => { /// let end = before.and_then(|before| base64::decode(before).ok()) /// .and_then(|data| data.as_slice().read_i32::<BE>().ok()) /// .unwrap_or(0); /// let start = end - *limit as i32; /// (start, end) /// } /// }; /// /// let nodes = (start..end).into_iter().map(|n| (base64::encode(n.to_be_bytes()), DiffFields(n - 1000), n)).collect(); /// Ok(Connection::new(None, true, true, nodes)) /// } /// } /// /// #[Object] /// impl QueryRoot { /// #[field] /// async fn numbers(&self, ctx: &Context<'_>, /// after: Option<String>, /// before: Option<String>, /// first: Option<i32>, /// last: Option<i32> /// ) -> Result<Connection<i32, DiffFields>> { /// Numbers.query(ctx, after, before, first, last).await /// } /// } /// /// #[async_std::main] /// async fn main() { /// let schema = Schema::new(QueryRoot, EmptyMutation, EmptySubscription); /// /// assert_eq!(schema.query("{ numbers(first: 2) { edges { node } } }").execute().await.unwrap(), serde_json::json!({ /// "numbers": { /// "edges": [ /// {"node": 0}, /// {"node": 1} /// ] /// }, /// })); /// /// assert_eq!(schema.query("{ numbers(last: 2) { edges { node diff } } }").execute().await.unwrap(), serde_json::json!({ /// "numbers": { /// "edges": [ /// {"node": -2, "diff": -1002}, /// {"node": -1, "diff": -1001} /// ] /// }, /// })); /// } /// ``` #[async_trait::async_trait] pub trait DataSource: Sync + Send { /// Record type type Element; /// Fields for Edge /// /// Is a type that implements `ObjectType` and can be defined by the procedure macro `#[Object]`. type EdgeFieldsObj: ObjectType + Send + Sync; /// Execute the query. async fn query( &self, ctx: &Context<'_>, after: Option<String>, before: Option<String>, first: Option<i32>, last: Option<i32>, ) -> Result<Connection<Self::Element, Self::EdgeFieldsObj>> { let operation = if let Some(after) = &after { QueryOperation::Forward { after: Some(after), limit: match first { Some(value) => { if value < 0 { return Err(QueryError::ArgumentMustBeNonNegative { field_name: ctx.name.clone(), } .into()); } else { value as usize } } None => 10, }, } } else if let Some(before) = &before { QueryOperation::Backward { before: Some(before), limit: match last { Some(value) => { if value < 0 { return Err(QueryError::ArgumentMustBeNonNegative { field_name: ctx.name.clone(), } .into()); } else { value as usize } } None => 10, }, } } else if let Some(first) = first { QueryOperation::Forward { after: None, limit: if first < 0 { return Err(QueryError::ArgumentMustBeNonNegative { field_name: ctx.name.clone(), } .into()); } else { first as usize }, } } else if let Some(last) = last { QueryOperation::Backward { before: None, limit: if last < 0 { return Err(QueryError::ArgumentMustBeNonNegative { field_name: ctx.name.clone(), } .into()); } else { last as usize }, } } else { QueryOperation::Forward { after: None, limit: 10, } }; self.query_operation(&operation).await } /// Parses the parameters and executes the query,Usually you just need to implement this method. async fn query_operation( &self, operation: &QueryOperation<'_>, ) -> Result<Connection<Self::Element, Self::EdgeFieldsObj>>; }