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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
use parser::{ParseError, ScalarToken}; use serde::de; use serde::ser::Serialize; use std::fmt::{self, Debug, Display}; /// The result of converting a string into a scalar value pub type ParseScalarResult<'a, S = DefaultScalarValue> = Result<S, ParseError<'a>>; /// A trait used to convert a `ScalarToken` into a certain scalar value type pub trait ParseScalarValue<S = DefaultScalarValue> { /// See the trait documentation fn from_str<'a>(value: ScalarToken<'a>) -> ParseScalarResult<'a, S>; } /// A trait marking a type that could be used as internal representation of /// scalar values in juniper /// /// The main objective of this abstraction is to allow other libraries to /// replace the default representation with something that better fits thei /// needs. /// There is a custom derive (`#[derive(ScalarValue)]`) available that implements /// most of the required traits automatically for a enum representing a scalar value. /// This derives needs a additional annotation of the form /// `#[juniper(visitor = "VisitorType")]` to specify a type that implements /// `serde::de::Visitor` and that is used to deserialize the value. /// /// # Implementing a new scalar value representation /// The preferred way to define a new scalar value representation is /// defining a enum containing a variant for each type that needs to be represented /// at the lowest level. /// The following example introduces an new variant that is able to store 64 bit integers. /// /// ``` /// # #[macro_use] /// # extern crate juniper; /// # extern crate serde; /// # use serde::{de, Deserialize, Deserializer}; /// # use juniper::ScalarValue; /// # use std::fmt; /// # /// #[derive(Debug, Clone, PartialEq, ScalarValue)] /// enum MyScalarValue { /// Int(i32), /// Long(i64), /// Float(f64), /// String(String), /// Boolean(bool), /// } /// /// impl ScalarValue for MyScalarValue { /// type Visitor = MyScalarValueVisitor; /// /// fn as_int(&self) -> Option<i32> { /// match *self { /// MyScalarValue::Int(ref i) => Some(*i), /// _ => None, /// } /// } /// /// fn as_string(&self) -> Option<String> { /// match *self { /// MyScalarValue::String(ref s) => Some(s.clone()), /// _ => None, /// } /// } /// /// fn as_float(&self) -> Option<f64> { /// match *self { /// MyScalarValue::Int(ref i) => Some(*i as f64), /// MyScalarValue::Float(ref f) => Some(*f), /// _ => None, /// } /// } /// /// fn as_boolean(&self) -> Option<bool> { /// match *self { /// MyScalarValue::Boolean(ref b) => Some(*b), /// _ => None, /// } /// } /// } /// /// #[derive(Default)] /// struct MyScalarValueVisitor; /// /// impl<'de> de::Visitor<'de> for MyScalarValueVisitor { /// type Value = MyScalarValue; /// /// fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { /// formatter.write_str("a valid input value") /// } /// /// fn visit_bool<E>(self, value: bool) -> Result<MyScalarValue, E> { /// Ok(MyScalarValue::Boolean(value)) /// } /// /// fn visit_i32<E>(self, value: i32) -> Result<MyScalarValue, E> /// where /// E: de::Error, /// { /// Ok(MyScalarValue::Int(value)) /// } /// /// fn visit_i64<E>(self, value: i64) -> Result<MyScalarValue, E> /// where /// E: de::Error, /// { /// if value <= i32::max_value() as i64 { /// self.visit_i32(value as i32) /// } else { /// Ok(MyScalarValue::Long(value)) /// } /// } /// /// fn visit_u32<E>(self, value: u32) -> Result<MyScalarValue, E> /// where /// E: de::Error, /// { /// if value <= i32::max_value() as u32 { /// self.visit_i32(value as i32) /// } else { /// self.visit_u64(value as u64) /// } /// } /// /// fn visit_u64<E>(self, value: u64) -> Result<MyScalarValue, E> /// where /// E: de::Error, /// { /// if value <= i64::max_value() as u64 { /// self.visit_i64(value as i64) /// } else { /// // Browser's JSON.stringify serialize all numbers having no /// // fractional part as integers (no decimal point), so we /// // must parse large integers as floating point otherwise /// // we would error on transferring large floating point /// // numbers. /// Ok(MyScalarValue::Float(value as f64)) /// } /// } /// /// fn visit_f64<E>(self, value: f64) -> Result<MyScalarValue, E> { /// Ok(MyScalarValue::Float(value)) /// } /// /// fn visit_str<E>(self, value: &str) -> Result<MyScalarValue, E> /// where /// E: de::Error, /// { /// self.visit_string(value.into()) /// } /// /// fn visit_string<E>(self, value: String) -> Result<MyScalarValue, E> { /// Ok(MyScalarValue::String(value)) /// } /// } /// /// # fn main() {} /// ``` pub trait ScalarValue: Debug + Display + PartialEq + Clone + Serialize + From<String> + From<bool> + From<i32> + From<f64> + Into<Option<bool>> + Into<Option<i32>> + Into<Option<f64>> + Into<Option<String>> { /// Serde visitor used to deserialize this scalar value type Visitor: for<'de> de::Visitor<'de, Value = Self> + Default; /// Checks if the current value contains the a value of the current type /// /// ``` /// # use juniper::{ScalarValue, DefaultScalarValue}; /// /// let value = DefaultScalarValue::Int(42); /// /// assert_eq!(value.is_type::<i32>(), true); /// assert_eq!(value.is_type::<f64>(), false); /// /// ``` fn is_type<'a, T>(&'a self) -> bool where T: 'a, &'a Self: Into<Option<&'a T>>, { self.into().is_some() } /// Convert the given scalar value into an integer value /// /// This function is used for implementing `GraphQLType` for `i32` for all /// scalar values. Implementations should convert all supported integer /// types with 32 bit or less to an integer if requested. fn as_int(&self) -> Option<i32>; /// Convert the given scalar value into a string value /// /// This function is used for implementing `GraphQLType` for `String` for all /// scalar values fn as_string(&self) -> Option<String>; /// Convert the given scalar value into a float value /// /// This function is used for implementing `GraphQLType` for `f64` for all /// scalar values. Implementations should convert all supported integer /// types with 64 bit or less and all floating point values with 64 bit or /// less to a float if requested. fn as_float(&self) -> Option<f64>; /// Convert the given scalar value into a boolean value /// /// This function is used for implementing `GraphQLType` for `bool` for all /// scalar values. fn as_boolean(&self) -> Option<bool>; } /// A marker trait extending the [`ScalarValue`](../trait.ScalarValue.html) trait /// /// This trait should not be relied on directly by most apps. However, you may /// need a where clause in the form of `for<'b> &'b S: ScalarRefValue<'b>` to /// abstract over different scalar value types. /// /// This is automatically implemented for a type as soon as the type implements /// `ScalarValue` and the additional conversations. pub trait ScalarRefValue<'a>: Debug + Into<Option<&'a bool>> + Into<Option<&'a i32>> + Into<Option<&'a String>> + Into<Option<&'a f64>> { } impl<'a, T> ScalarRefValue<'a> for &'a T where T: ScalarValue, &'a T: Into<Option<&'a bool>> + Into<Option<&'a i32>> + Into<Option<&'a String>> + Into<Option<&'a f64>>, {} /// The default scalar value representation in juniper /// /// This types closely follows the graphql specification. #[derive(Debug, PartialEq, Clone, GraphQLScalarValueInternal)] #[allow(missing_docs)] pub enum DefaultScalarValue { Int(i32), Float(f64), String(String), Boolean(bool), } impl ScalarValue for DefaultScalarValue { type Visitor = DefaultScalarValueVisitor; fn as_int(&self) -> Option<i32> { match *self { DefaultScalarValue::Int(ref i) => Some(*i), _ => None, } } fn as_string(&self) -> Option<String> { match *self { DefaultScalarValue::String(ref s) => Some(s.clone()), _ => None, } } fn as_float(&self) -> Option<f64> { match *self { DefaultScalarValue::Int(ref i) => Some(*i as f64), DefaultScalarValue::Float(ref f) => Some(*f), _ => None, } } fn as_boolean(&self) -> Option<bool> { match *self { DefaultScalarValue::Boolean(ref b) => Some(*b), _ => None, } } } impl<'a> From<&'a str> for DefaultScalarValue { fn from(s: &'a str) -> Self { DefaultScalarValue::String(s.into()) } } #[derive(Default, Clone, Copy, Debug)] pub struct DefaultScalarValueVisitor; impl<'de> de::Visitor<'de> for DefaultScalarValueVisitor { type Value = DefaultScalarValue; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("a valid input value") } fn visit_bool<E>(self, value: bool) -> Result<DefaultScalarValue, E> { Ok(DefaultScalarValue::Boolean(value)) } fn visit_i64<E>(self, value: i64) -> Result<DefaultScalarValue, E> where E: de::Error, { if value >= i64::from(i32::min_value()) && value <= i64::from(i32::max_value()) { Ok(DefaultScalarValue::Int(value as i32)) } else { // Browser's JSON.stringify serialize all numbers having no // fractional part as integers (no decimal point), so we // must parse large integers as floating point otherwise // we would error on transferring large floating point // numbers. Ok(DefaultScalarValue::Float(value as f64)) } } fn visit_u64<E>(self, value: u64) -> Result<DefaultScalarValue, E> where E: de::Error, { if value <= i32::max_value() as u64 { self.visit_i64(value as i64) } else { // Browser's JSON.stringify serialize all numbers having no // fractional part as integers (no decimal point), so we // must parse large integers as floating point otherwise // we would error on transferring large floating point // numbers. Ok(DefaultScalarValue::Float(value as f64)) } } fn visit_f64<E>(self, value: f64) -> Result<DefaultScalarValue, E> { Ok(DefaultScalarValue::Float(value)) } fn visit_str<E>(self, value: &str) -> Result<DefaultScalarValue, E> where E: de::Error, { self.visit_string(value.into()) } fn visit_string<E>(self, value: String) -> Result<DefaultScalarValue, E> { Ok(DefaultScalarValue::String(value)) } }