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 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
//! Helper types for making the construction of filter, update, etc. documents //! a little less stringly-typed. use std::str; use std::fmt; use bson::{ Bson, to_bson }; use serde::{ ser::{ Serialize, Serializer, SerializeSeq }, de::{ Deserialize, Deserializer, Visitor, SeqAccess }, }; /// Ordering, for specifying in which order to sort results yielded by a query. /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use avocado::literal::Order; /// # /// # fn main() { /// let sorting = doc! { /// "_id": Order::Ascending, /// "zip": Order::Descending, /// }; /// assert_eq!(sorting, doc!{ /// "_id": 1, /// "zip": -1, /// }); /// # } /// ``` #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum Order { /// Order smaller values first. Ascending = 1, /// Order greater values first. Descending = -1, } /// The default ordering is `Ascending`. impl Default for Order { fn default() -> Self { Order::Ascending } } /// This impl is provided so that you can use these more expressive ordering /// names instead of the not very clear `1` and `-1` when constructing literal /// BSON index documents. impl From<Order> for Bson { fn from(order: Order) -> Self { Bson::I32(order as _) } } /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use bson::to_bson; /// # use avocado::prelude::*; /// # /// # fn main() -> AvocadoResult<()> { /// # /// assert_eq!(to_bson(&Order::Ascending)?, Bson::from(Order::Ascending)); /// assert_eq!(to_bson(&Order::Descending)?, Bson::from(Order::Descending)); /// # /// # Ok(()) /// # } /// ``` impl Serialize for Order { fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error> { ser.serialize_i32(*self as _) } } /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use bson::from_bson; /// # use avocado::prelude::*; /// # /// # fn main() -> AvocadoResult<()> { /// # /// let asc_i32 = Bson::I32(1); /// let desc_i64 = Bson::I64(-1); /// let asc_float = Bson::FloatingPoint(1.0); /// /// let bad_i32 = Bson::I32(0); /// let bad_float = Bson::FloatingPoint(-2.0); /// let bad_type = Bson::from("Ascending"); /// /// assert_eq!(from_bson::<Order>(asc_i32)?, Order::Ascending); /// assert_eq!(from_bson::<Order>(desc_i64)?, Order::Descending); /// assert_eq!(from_bson::<Order>(asc_float)?, Order::Ascending); /// /// assert!(from_bson::<Order>(bad_i32) /// .unwrap_err() /// .to_string() /// .contains("invalid ordering")); /// assert!(from_bson::<Order>(bad_float) /// .unwrap_err() /// .to_string() /// .contains("invalid ordering")); /// assert!(from_bson::<Order>(bad_type) /// .unwrap_err() /// .to_string() /// .contains("an integer expressing ordering")); /// # /// # Ok(()) /// # } /// ``` impl<'a> Deserialize<'a> for Order { fn deserialize<D: Deserializer<'a>>(de: D) -> Result<Self, D::Error> { de.deserialize_i32(OrderVisitor) } } /// A serde visitor that produces an `Order` from +1 or -1. struct OrderVisitor; impl<'a> Visitor<'a> for OrderVisitor { type Value = Order; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { write!( formatter, "an integer expressing ordering: {} or {}", Order::Ascending as i32, Order::Descending as i32, ) } fn visit_i64<E: serde::de::Error>(self, v: i64) -> Result<Self::Value, E> { if v == Order::Ascending as i64 { Ok(Order::Ascending) } else if v == Order::Descending as i64 { Ok(Order::Descending) } else { Err(E::custom(format!("invalid ordering: {}", v))) } } fn visit_u64<E: serde::de::Error>(self, v: u64) -> Result<Self::Value, E> { if v == Order::Ascending as u64 { Ok(Order::Ascending) } else { Err(E::custom(format!("invalid ordering: {}", v))) } } #[allow(clippy::float_cmp, clippy::cast_lossless, clippy::cast_precision_loss)] fn visit_f64<E: serde::de::Error>(self, v: f64) -> Result<Self::Value, E> { if v == Order::Ascending as i32 as f64 { Ok(Order::Ascending) } else if v == Order::Descending as i32 as f64 { Ok(Order::Descending) } else { Err(E::custom(format!("invalid ordering: {}", v))) } } } /// An index type, applied to a single indexed field. /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use avocado::literal::{ IndexType, Order }; /// # /// # fn main() { /// let patient_index = doc!{ /// "description": IndexType::Text, /// "body.mass": IndexType::Ordered(Order::Ascending), /// "birth_date.year": IndexType::Ordered(Order::Descending), /// "address_gps_coords": IndexType::Geo2DSphere, /// }; /// assert_eq!(patient_index, doc!{ /// "description": "text", /// "body.mass": 1, /// "birth_date.year": -1, /// "address_gps_coords": "2dsphere", /// }); /// # /// # } /// ``` #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum IndexType { /// An ordered index field. Ordered(Order), /// A language-specific textual index, most useful for freetext searches. Text, /// Hashed index for hash-based sharding. Hashed, /// 2D geospatial index with planar (Euclidean) geometry. Geo2D, /// 2D geospatial index with spherical geometry. Geo2DSphere, /// 2D geospatial index optimized for very small areas. GeoHaystack, } impl From<IndexType> for Bson { fn from(index_type: IndexType) -> Self { match index_type { IndexType::Ordered(order) => Bson::from(order), IndexType::Text => Bson::from("text"), IndexType::Hashed => Bson::from("hashed"), IndexType::Geo2D => Bson::from("2d"), IndexType::Geo2DSphere => Bson::from("2dsphere"), IndexType::GeoHaystack => Bson::from("geoHaystack"), } } } /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use bson::{ to_bson, from_bson }; /// # use avocado::prelude::*; /// # /// # fn main() -> AvocadoResult<()> { /// # /// let asc = IndexType::Ordered(Order::Ascending); /// let desc = IndexType::Ordered(Order::Descending); /// let haystack = IndexType::GeoHaystack; /// let text = IndexType::Text; /// let planar_2d = IndexType::Geo2D; /// let spherical_2d = IndexType::Geo2DSphere; /// /// assert_eq!(to_bson(&asc)?, Bson::from(asc)); /// assert_eq!(to_bson(&desc)?, Bson::from(desc)); /// assert_eq!(to_bson(&haystack)?, Bson::from(haystack)); /// assert_eq!(to_bson(&text)?, Bson::from(text)); /// assert_eq!(to_bson(&planar_2d)?, Bson::from(planar_2d)); /// assert_eq!(to_bson(&spherical_2d)?, Bson::from(spherical_2d)); /// # /// # Ok(()) /// # } /// ``` impl Serialize for IndexType { fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error> { Bson::from(*self).serialize(ser) } } /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use bson::from_bson; /// # use avocado::prelude::*; /// # /// # fn main() -> AvocadoResult<()> { /// # /// let asc_i32 = Bson::I32(1); /// let desc_i64 = Bson::I64(-1); /// let asc_float = Bson::FloatingPoint(1.0); /// let text = Bson::from("text"); /// let spherical_2d = Bson::from("2dsphere"); /// let hashed = Bson::from("hashed"); /// /// let bad_i64 = Bson::I64(0); /// let bad_float = Bson::FloatingPoint(3.14); /// let bad_str = Bson::from("Ascending"); /// let bad_type = Bson::Boolean(true); /// /// assert_eq!(from_bson::<IndexType>(asc_i32)?, /// IndexType::Ordered(Order::Ascending)); /// assert_eq!(from_bson::<IndexType>(desc_i64)?, /// IndexType::Ordered(Order::Descending)); /// assert_eq!(from_bson::<IndexType>(asc_float)?, /// IndexType::Ordered(Order::Ascending)); /// assert_eq!(from_bson::<IndexType>(text)?, /// IndexType::Text); /// assert_eq!(from_bson::<IndexType>(spherical_2d)?, /// IndexType::Geo2DSphere); /// assert_eq!(from_bson::<IndexType>(hashed)?, /// IndexType::Hashed); /// /// assert!(from_bson::<IndexType>(bad_i64) /// .unwrap_err() /// .to_string() /// .contains("invalid ordering")); /// assert!(from_bson::<IndexType>(bad_float) /// .unwrap_err() /// .to_string() /// .contains("invalid ordering")); /// assert!(from_bson::<IndexType>(bad_str) /// .unwrap_err() /// .to_string() /// .contains("unrecognized index type")); /// assert!(from_bson::<IndexType>(bad_type) /// .unwrap_err() /// .to_string() /// .contains("an ordering integer or an index type string")); /// # /// # Ok(()) /// # } /// ``` impl<'a> Deserialize<'a> for IndexType { fn deserialize<D: Deserializer<'a>>(de: D) -> Result<Self, D::Error> { de.deserialize_any(IndexTypeVisitor) } } /// A serde visitor that produces an `IndexType` from its raw representation, /// which is either an ordering integer (+/- 1) or an index type string. struct IndexTypeVisitor; impl<'a> Visitor<'a> for IndexTypeVisitor { type Value = IndexType; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("an ordering integer or an index type string") } fn visit_i64<E: serde::de::Error>(self, v: i64) -> Result<Self::Value, E> { OrderVisitor.visit_i64(v).map(IndexType::Ordered) } fn visit_u64<E: serde::de::Error>(self, v: u64) -> Result<Self::Value, E> { OrderVisitor.visit_u64(v).map(IndexType::Ordered) } fn visit_f64<E: serde::de::Error>(self, v: f64) -> Result<Self::Value, E> { OrderVisitor.visit_f64(v).map(IndexType::Ordered) } fn visit_str<E: serde::de::Error>(self, v: &str) -> Result<Self::Value, E> { Ok(match v { "text" => IndexType::Text, "hashed" => IndexType::Hashed, "2d" => IndexType::Geo2D, "2dsphere" => IndexType::Geo2DSphere, "geoHaystack" => IndexType::GeoHaystack, _ => Err(E::custom(format!("unrecognized index type: {}", v)))? }) } } bitflags! { /// Non-deprecated BSON types. For use with the `$type` operator. /// /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use avocado::literal::BsonType; /// # /// # fn main() { /// let queries = bson!([ /// { "$type": BsonType::OBJECT_ID }, /// { "$type": [ BsonType::STRING, BsonType::default() ] }, /// ]); /// assert_eq!(queries, bson!([{ "$type": "objectId" }, /// { "$type": ["string", "null"] }])); /// # } /// ``` pub struct BsonType: u16 { /// The `null` value. const NULL = 0b0000_0000_0000_0001; /// `true` or `false`. const BOOL = 0b0000_0000_0000_0010; /// Double-precision floating-point number. const DOUBLE = 0b0000_0000_0000_0100; /// 32-bit signed integer. const INT = 0b0000_0000_0000_1000; /// 64-bit signed integer. const LONG = 0b0000_0000_0001_0000; /// 128-bit decimal number. const DECIMAL = 0b0000_0000_0010_0000; /// Any of the 4 numeric types (`double`, `int`, `long`, `decimal`). const NUMBER = 0b0000_0000_0011_1100; /// `ObjectId`. const OBJECT_ID = 0b0000_0000_0100_0000; /// Timestamp. const TIMESTAMP = 0b0000_0000_1000_0000; /// Date and time. const DATE = 0b0000_0001_0000_0000; /// String. const STRING = 0b0000_0010_0000_0000; /// Regular expression and its matching options. const REGEX = 0b0000_0100_0000_0000; /// Binary data, BLOB. const BINARY = 0b0000_1000_0000_0000; /// Array. const ARRAY = 0b0001_0000_0000_0000; /// Document or object. const DOCUMENT = 0b0010_0000_0000_0000; /// JavaScript code. const JAVASCRIPT = 0b0100_0000_0000_0000; /// JavaScript code with scope. const JAVASCRIPT_WITH_SCOPE = 0b1000_0000_0000_0000; } } /// The default BSON type is `null`. impl Default for BsonType { fn default() -> Self { BsonType::NULL } } /// This is possible because encoding `BsonType` as a `Bson` never actually /// fails (the in-memory tree serializer always succeeds unless the value /// being serialized itself provokes an error, which our `BsonType` doesn't.) impl From<BsonType> for Bson { fn from(bson_type: BsonType) -> Self { to_bson(&bson_type).unwrap_or_default() } } /// All distinct BSON type bitflags, along with their string aliases. static TYPE_NAMES: &[(BsonType, &str)] = &[ (BsonType::NULL, "null"), (BsonType::BOOL, "bool"), (BsonType::DOUBLE, "double"), (BsonType::INT, "int"), (BsonType::LONG, "int"), (BsonType::DECIMAL, "decimal"), (BsonType::OBJECT_ID, "objectId"), (BsonType::TIMESTAMP, "timestamp"), (BsonType::DATE, "date"), (BsonType::STRING, "string"), (BsonType::REGEX, "regex"), (BsonType::BINARY, "binData"), (BsonType::ARRAY, "array"), (BsonType::DOCUMENT, "object"), (BsonType::JAVASCRIPT, "javascript"), (BsonType::JAVASCRIPT_WITH_SCOPE, "javascriptWithScope"), ]; impl Serialize for BsonType { fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> { use serde::ser::Error; match self.bits().count_ones() { 0 => Err(S::Error::custom("at least one type must be specified")), 1 => { for &(flag, name) in TYPE_NAMES { if self.contains(flag) { return serializer.serialize_str(name); } } Err(S::Error::custom("found an unexpected flag")) } n => { let mut seq = serializer.serialize_seq(Some(n as usize))?; for &(flag, name) in TYPE_NAMES { if self.contains(flag) { seq.serialize_element(name)?; } } seq.end() } } } } impl<'a> Deserialize<'a> for BsonType { fn deserialize<D: Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error> { deserializer.deserialize_any(BsonTypeVisitor) } } /// A `Visitor` for converting a BSON type alias or an array thereof to a `BsonType` bitflag. #[derive(Debug, Clone, Copy)] struct BsonTypeVisitor; impl BsonTypeVisitor { /// Attempts to convert a BSON type alias to a `BsonType` bitflag. fn bitflag_for_name<E: serde::de::Error>(name: &str) -> Result<BsonType, E> { match TYPE_NAMES.iter().find(|&&(_, n)| n == name) { Some(&(flag, _)) => Ok(flag), None => Err(E::custom(format!("unknown BSON type alias: '{}'", name))), } } } impl<'a> Visitor<'a> for BsonTypeVisitor { type Value = BsonType; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("a BSON type alias string or an array of BSON type alias strings") } fn visit_str<E: serde::de::Error>(self, value: &str) -> Result<Self::Value, E> { Self::bitflag_for_name(value) } fn visit_seq<A: SeqAccess<'a>>(self, mut seq: A) -> Result<Self::Value, A::Error> { let mut flags = BsonType::empty(); while let Some(name) = seq.next_element()? { flags |= Self::bitflag_for_name(name)?; } Ok(flags) } } bitflags! { /// Options for matching text against a regular expression. /// Useful with the `$regex` operator. E.g.: /// /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use avocado::literal::RegexOpts; /// # /// # fn main() { /// let query = doc!{ /// "name": { /// "$regex": "^Foo", /// "$options": RegexOpts::LINE_ANCHOR | RegexOpts::IGNORE_CASE, /// }, /// "address": { /// "$regex": ".* street$", /// "$options": RegexOpts::default(), /// }, /// }; /// assert_eq!(query, doc!{ /// "name": { /// "$regex": "^Foo", /// "$options": "im", /// }, /// "address": { /// "$regex": ".* street$", /// "$options": "", /// }, /// }); /// # } /// ``` #[derive(Default)] pub struct RegexOpts: u8 { /// Case insensitive matching. const IGNORE_CASE = 0b0000_0001; /// `^` and `$` match the beginning and the end of lines, not the whole string. const LINE_ANCHOR = 0b0000_0010; /// "extended" syntax, allows embedded whitespace and `#`-comments const EXTENDED = 0b0000_0100; /// The `.` character matches newlines too. const DOT_NEWLINE = 0b0000_1000; } } /// See the explanation for `BsonType` as to why this impl is possible. impl From<RegexOpts> for Bson { fn from(options: RegexOpts) -> Self { to_bson(&options).unwrap_or_default() } } /// Bitflags for each regex option, along with its letter representation. static OPTION_LETTERS: &[(RegexOpts, u8)] = &[ (RegexOpts::IGNORE_CASE, b'i'), (RegexOpts::LINE_ANCHOR, b'm'), (RegexOpts::EXTENDED, b'x'), (RegexOpts::DOT_NEWLINE, b's'), ]; impl Serialize for RegexOpts { fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> { use std::mem::size_of; use serde::ser::Error; // can't have more than this many distinct bits/flags let mut letters = [0; size_of::<Self>() * 8]; let mut n = 0; for &(option, letter) in OPTION_LETTERS { if self.contains(option) { letters[n] = letter; n += 1; } } let s = str::from_utf8(&letters[..n]).map_err(S::Error::custom)?; serializer.serialize_str(s) } } impl<'a> Deserialize<'a> for RegexOpts { fn deserialize<D: Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error> { deserializer.deserialize_str(RegexOptsVisitor) } } /// A visitor for deserializing `RegexOpts`. #[derive(Debug, Clone, Copy)] struct RegexOptsVisitor; impl<'a> Visitor<'a> for RegexOptsVisitor { type Value = RegexOpts; fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result { formatter.write_str("a string containing one of [imxs]") } fn visit_str<E: serde::de::Error>(self, value: &str) -> Result<Self::Value, E> { let mut options = RegexOpts::empty(); for byte in value.bytes() { match OPTION_LETTERS.iter().find(|&&(_, b)| b == byte) { Some(&(option, _)) => options |= option, None => return Err(E::custom(format!("unexpected regex option: '{}'", byte as char))), } } Ok(options) } } /// Tells the `$currentDate` operator which type it should use for setting its fields. /// /// ``` /// # #[macro_use] /// # extern crate bson; /// # extern crate avocado; /// # /// # use avocado::literal::DateTimeType; /// # /// # fn main() { /// let update = doc!{ /// "$currentDate": { /// "date": DateTimeType::Date, /// "time": DateTimeType::Timestamp, /// } /// }; /// assert_eq!(update, doc!{ /// "$currentDate": { /// "date": "date", /// "time": "timestamp", /// } /// }); /// # } /// ``` #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub enum DateTimeType { /// the `$currentDate` operator will set the field to a timestamp value. Timestamp, /// the `$currentDate` operator will set the field to a `Date` value. Date, } /// See the explanation for `BsonType` as to why this impl is possible. impl From<DateTimeType> for Bson { fn from(ty: DateTimeType) -> Self { to_bson(&ty).unwrap_or_default() } }