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
//! Types for Relay-compliant server mod connection_type; mod cursor; mod edge; mod page_info; mod slice; use crate::{Context, FieldResult}; pub use connection_type::Connection; pub use cursor::CursorType; pub use edge::Edge; pub use page_info::PageInfo; use std::fmt::Display; /// Empty additional fields #[async_graphql_derive::SimpleObject(internal)] pub struct EmptyFields; /// 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 async_graphql::connection::*; /// /// struct QueryRoot; /// /// struct Numbers; /// /// #[SimpleObject] /// struct Diff { /// diff: i32, /// } /// /// #[DataSource] /// impl DataSource for Numbers { /// type CursorType = usize; /// type NodeType = i32; /// type ConnectionFieldsType = EmptyFields; /// type EdgeFieldsType = Diff; /// /// async fn execute_query(&self, /// ctx: &Context<'_>, /// after: Option<usize>, /// before: Option<usize>, /// first: Option<usize>, /// last: Option<usize>, /// ) -> FieldResult<Connection<Self::CursorType, Self::NodeType, Self::ConnectionFieldsType, Self::EdgeFieldsType>> { /// let mut start = after.map(|after| after + 1).unwrap_or(0); /// let mut end = before.unwrap_or(10000); /// if let Some(first) = first { /// end = (start + first).min(end); /// } /// if let Some(last) = last { /// start = if last > end - start { /// end /// } else { /// end - last /// }; /// } /// let mut connection = Connection::new(start > 0, end < 10000); /// connection.append( /// (start..end).into_iter().map(|n| /// Edge::with_additional_fields(n, n as i32, Diff{ diff: (10000 - n) as i32 })), /// ); /// Ok(connection) /// } /// } /// /// #[Object] /// impl QueryRoot { /// async fn numbers(&self, ctx: &Context<'_>, /// after: Option<String>, /// before: Option<String>, /// first: Option<i32>, /// last: Option<i32> /// ) -> FieldResult<Connection<usize, i32, EmptyFields, Diff>> { /// Numbers.query(ctx, after, before, first, last).await /// } /// } /// /// #[async_std::main] /// async fn main() { /// let schema = Schema::new(QueryRoot, EmptyMutation, EmptySubscription); /// /// assert_eq!(schema.execute("{ numbers(first: 2) { edges { node diff } } }").await.unwrap().data, serde_json::json!({ /// "numbers": { /// "edges": [ /// {"node": 0, "diff": 10000}, /// {"node": 1, "diff": 9999}, /// ] /// }, /// })); /// /// assert_eq!(schema.execute("{ numbers(last: 2) { edges { node diff } } }").await.unwrap().data, serde_json::json!({ /// "numbers": { /// "edges": [ /// {"node": 9998, "diff": 2}, /// {"node": 9999, "diff": 1}, /// ] /// }, /// })); /// } /// ``` #[async_trait::async_trait] pub trait DataSource { /// Cursor type type CursorType: CursorType + Send + Sync; /// Record type type NodeType; /// Additional fields for connection /// /// Is a type that implements `ObjectType` and can be defined by the procedure macro `#[Object]` or `#[SimpleObject]`. /// type ConnectionFieldsType; /// Additional fields for edge /// /// Is a type that implements `ObjectType` and can be defined by the procedure macro `#[Object]` or `#[SimpleObject]`. /// type EdgeFieldsType; /// Parses the parameters and executes the query. async fn query( &self, ctx: &Context<'_>, after: Option<String>, before: Option<String>, first: Option<i32>, last: Option<i32>, ) -> FieldResult< Connection< Self::CursorType, Self::NodeType, Self::ConnectionFieldsType, Self::EdgeFieldsType, >, > where <Self::CursorType as CursorType>::Error: Display + Send + Sync + 'static, { if first.is_some() && last.is_some() { return Err( "The \"first\" and \"last\" parameters cannot exist at the same time".into(), ); } let first = match first { Some(first) if first < 0 => { return Err("The \"first\" parameter must be a non-negative number".into()) } Some(first) => Some(first as usize), None => None, }; let last = match last { Some(last) if last < 0 => { return Err("The \"last\" parameter must be a non-negative number".into()) } Some(last) => Some(last as usize), None => None, }; let before = match before { Some(before) => Some(Self::CursorType::decode_cursor(&before)?), None => None, }; let after = match after { Some(after) => Some(Self::CursorType::decode_cursor(&after)?), None => None, }; self.execute_query(ctx, after, before, first, last).await } /// Execute query async fn execute_query( &self, ctx: &Context<'_>, after: Option<Self::CursorType>, before: Option<Self::CursorType>, first: Option<usize>, last: Option<usize>, ) -> FieldResult< Connection< Self::CursorType, Self::NodeType, Self::ConnectionFieldsType, Self::EdgeFieldsType, >, >; }