Packages

package bson

import reactivemongo.api.bson._

// { "name": "Johny", "surname": "Doe", "age": 28, "months": [1, 2, 3] }
document ++ ("name" -> "Johny") ++ ("surname" -> "Doe") ++
("age" -> 28) ++ ("months" -> array(1, 2, 3))

// { "_id": generatedId, "name": "Jane", "surname": "Doe", "age": 28,
//   "months": [1, 2, 3], "details": { "salary": 12345,
//   "inventory": ["foo", 7.8, 0, false] } }
document ++ ("_id" -> generateId, "name" -> "Jane", "surname" -> "Doe",
  "age" -> 28, "months" -> array(1, 2, 3),
  "details" -> document(
    "salary" -> 12345L, "inventory" -> array("foo", 7.8, 0L, false)))
Linear Supertypes
Utils, Aliases, DefaultBSONHandlers, BSONIdentityHandlers, BSONIdentityLowPriorityHandlers, LowPriority1BSONHandlers, LowPriority2BSONHandlers, LowPriority3BSONHandlers, LowPriority4BSONHandlers, LowPriorityBSONHandlersCompat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. bson
  2. Utils
  3. Aliases
  4. DefaultBSONHandlers
  5. BSONIdentityHandlers
  6. BSONIdentityLowPriorityHandlers
  7. LowPriority1BSONHandlers
  8. LowPriority2BSONHandlers
  9. LowPriority3BSONHandlers
  10. LowPriority4BSONHandlers
  11. LowPriorityBSONHandlersCompat
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package exceptions

Type Members

  1. sealed abstract class BSONArray extends BSONValue

    A BSONArray structure (BSON type 0x04).

    A BSONArray structure (BSON type 0x04).

    A BSONArray is a indexed sequence of BSONValue.

  2. class BSONArrayCollectionReader[M[_], T] extends BSONReader[M[T]]
    Attributes
    protected
    Definition Classes
    LowPriority1BSONHandlers
  3. final class BSONBinary extends BSONValue

    A BSON binary value.

  4. final class BSONBoolean extends BSONValue with Value

    BSON boolean value

  5. sealed trait BSONBooleanLike extends AnyRef

    A BSON value that can be seen as a boolean.

    A BSON value that can be seen as a boolean.

    Conversions:

    • number = 0 ~> false
    • number != 0 ~> true
    • boolean
    • undefined ~> false
    • null ~> false
  6. final class BSONDateTime extends BSONValue with Value

    BSON date time value

  7. final class BSONDecimal extends BSONValue with Value with Value

    Value wrapper for a BSON 128-bit decimal.

  8. sealed abstract class BSONDocument extends BSONValue with ElementProducer with BSONDocumentLowPriority with BSONDocumentExperimental

    A BSONDocument structure (BSON type 0x03).

    A BSONDocument structure (BSON type 0x03).

    A BSONDocument is basically a set of fields (String, BSONValue).

    Note: The insertion/initial order of the fields may not be maintained through the operations.

  9. type BSONDocumentHandler[T] = BSONDocumentReader[T] with BSONDocumentWriter[T] with BSONHandler[T]

    Convenient type alias for document handlers

  10. trait BSONDocumentReader[T] extends BSONReader[T]
  11. trait BSONDocumentWriter[T] extends BSONWriter[T]
  12. final class BSONDouble extends BSONValue with Value with Value

    A BSON Double.

  13. sealed abstract class BSONElement extends ElementProducer
  14. trait BSONHandler[T] extends BSONReader[T] with BSONWriter[T]
  15. final class BSONInteger extends BSONValue with Value with Value

    BSON Integer value

  16. final class BSONJavaScript extends BSONValue

    BSON JavaScript value.

  17. final class BSONJavaScriptWS extends BSONValue

    BSON JavaScript value with scope (WS).

  18. final class BSONLong extends BSONValue with Value with Value

    BSON Long value

  19. sealed trait BSONMaxKey extends BSONValue

    BSON Max key value

  20. sealed trait BSONMinKey extends BSONValue

    BSON Min key value

  21. sealed trait BSONNull extends BSONValue with Value

    BSON null value

  22. sealed trait BSONNumberLike extends AnyRef

    A BSON value that can be seen as a number.

  23. sealed abstract class BSONObjectID extends BSONValue

    BSON ObjectId value.

    BSON ObjectId value.

    | Timestamp (seconds) | Machine identifier | Thread identifier | Increment

    | --- | --- | --- | ---

    | 4 bytes | 3 bytes | 2 bytes | 3 bytes

  24. trait BSONReader[T] extends AnyRef

    A reader that produces an instance of T from a subtype of BSONValue.

  25. final class BSONRegex extends BSONValue

    BSON Regex value.

  26. final class BSONString extends BSONValue
  27. final class BSONSymbol extends BSONValue

    BSON Symbol value.

  28. sealed abstract class BSONTimestamp extends BSONValue with Value

    BSON Timestamp value

  29. sealed trait BSONUndefined extends BSONValue with Value

    BSON undefined value

  30. sealed trait BSONValue extends AnyRef
  31. trait BSONWriter[T] extends AnyRef

    A writer that produces a subtype of BSONValue from an instance of T.

  32. type BaseColl[T] = Iterable[T]
    Definition Classes
    Aliases
  33. sealed trait ElementProducer extends Producer[BSONElement]
  34. trait FieldNaming extends (String) => String

    Naming strategy, to map each class property to the corresponding field.

  35. trait KeyReader[T] extends AnyRef

    Mapping from a BSON string to T

  36. trait KeyWriter[T] extends AnyRef

    Mapping from a BSON string to T

  37. sealed trait MacroConfiguration extends AnyRef

    Macro configuration

  38. sealed trait MacroOptions extends AnyRef

    Macros with 'Opts' suffix will take additional options in the form of type parameters that will customize behaviour of the macros during compilation.

  39. sealed trait Producer[T] extends AnyRef
  40. type StringOps = scala.collection.StringOps
    Definition Classes
    Aliases
  41. sealed trait Subtype extends AnyRef

    Binary Subtype

  42. trait TypeNaming extends (Class[_]) => String

    Naming strategy, to map each class to a discriminator value.

  43. final class ¬[A, B] extends AnyRef

    Type level evidence that type A is not type B.

    Type level evidence that type A is not type B.

    Annotations
    @SuppressWarnings()

Value Members

  1. def array(values: Producer[BSONValue]*): BSONArray

    Returns an array with given values.

  2. def array: BSONArray

    Returns an empty array.

  3. def bsonLocalDateHandler(zone: ZoneId): BSONHandler[LocalDate]

    Returns a BSON handler for java.time.LocalDate, considering the specified time zone.

    Returns a BSON handler for java.time.LocalDate, considering the specified time zone.

    Definition Classes
    DefaultBSONHandlers
    Annotations
    @inline()
  4. implicit val bsonLocalDateHandler: BSONHandler[LocalDate]
    Definition Classes
    DefaultBSONHandlers
  5. def bsonLocalDateTimeHandler(zone: ZoneId): BSONHandler[LocalDateTime]

    Returns a BSON handler for java.time.LocalDateTime, considering the specified time zone.

    Returns a BSON handler for java.time.LocalDateTime, considering the specified time zone.

    Definition Classes
    DefaultBSONHandlers
    Annotations
    @inline()
  6. implicit val bsonLocalDateTimeHandler: BSONHandler[LocalDateTime]
    Definition Classes
    DefaultBSONHandlers
  7. implicit def bsonMapKeyWriter[K, V <: BSONValue](implicit keyWriter: KeyWriter[K]): BSONDocumentWriter[Map[K, V]]
    Definition Classes
    LowPriority3BSONHandlers
  8. implicit def bsonMapWriter[V <: BSONValue]: BSONDocumentWriter[Map[String, V]]
    Definition Classes
    LowPriority1BSONHandlers
  9. def bsonOffsetDateTimeHandler(zone: ZoneId): BSONHandler[OffsetDateTime]

    Returns a BSON handler for java.time.OffsetDateTime, considering the specified time zone.

    Returns a BSON handler for java.time.OffsetDateTime, considering the specified time zone.

    Definition Classes
    DefaultBSONHandlers
    Annotations
    @inline()
  10. implicit val bsonOffsetDateTimeHandler: BSONHandler[OffsetDateTime]
    Definition Classes
    DefaultBSONHandlers
  11. def bsonZonedDateTimeHandler(zone: ZoneId): BSONHandler[ZonedDateTime]

    Returns a BSON handler for java.time.ZonedDateTime, considering the specified time zone.

    Returns a BSON handler for java.time.ZonedDateTime, considering the specified time zone.

    Definition Classes
    DefaultBSONHandlers
    Annotations
    @inline()
  12. implicit val bsonZonedDateTimeHandler: BSONHandler[ZonedDateTime]
    Definition Classes
    DefaultBSONHandlers
  13. implicit final def collectionReader[M[_], T](implicit f: Factory[T, M[T]], reader: BSONReader[T]): BSONReader[M[T]]
    Definition Classes
    LowPriorityBSONHandlersCompat
  14. implicit def collectionWriter[T, Repr](implicit arg0: (Repr) => Iterable[T], writer: BSONWriter[T], notOption: ¬[Repr, Option[T]]): BSONWriter[Repr]
    Definition Classes
    LowPriority1BSONHandlers
    Annotations
    @silent()
  15. def document(elements: ElementProducer*): BSONDocument

    Returns a document with given elements.

  16. def document: BSONDocument

    Returns an empty document.

  17. def element(name: String, value: BSONValue): BSONElement
  18. def generateId: BSONObjectID

    Returns a newly generated object ID.

  19. implicit def mapKeyReader[K, V](implicit keyReader: KeyReader[K], valueReader: BSONReader[V]): BSONDocumentReader[Map[K, V]]
    Definition Classes
    LowPriority2BSONHandlers
  20. implicit def mapKeySafeWriter[K, V](implicit keyWriter: KeyWriter[K] with SafeKeyWriter[K], valueWriter: BSONWriter[V] with SafeBSONWriter[V]): BSONDocumentWriter[Map[K, V]]
    Definition Classes
    LowPriority3BSONHandlers
  21. implicit def mapKeyWriter[K, V](implicit ev: (K) => StringOps, valueWriter: BSONWriter[V]): BSONDocumentWriter[Map[K, V]]
    Definition Classes
    LowPriority4BSONHandlers
  22. implicit def mapReader[V](implicit valueReader: BSONReader[V]): BSONDocumentReader[Map[String, V]]
    Definition Classes
    LowPriority1BSONHandlers
  23. implicit def mapSafeWriter[V](implicit valueWriter: BSONWriter[V] with SafeBSONWriter[V]): BSONDocumentWriter[Map[String, V]]
    Definition Classes
    LowPriority1BSONHandlers
  24. implicit def mapWriter[V](implicit valueWriter: BSONWriter[V]): BSONDocumentWriter[Map[String, V]]
    Definition Classes
    LowPriority2BSONHandlers
  25. object BSON

    Utility functions

  26. object BSONArray

    See BSONArray

  27. implicit object BSONArrayIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONArray]
    Definition Classes
    BSONIdentityHandlers
  28. object BSONBinary
  29. implicit object BSONBinaryHandler extends BSONHandler[Array[Byte]] with SafeBSONWriter[Array[Byte]]
    Definition Classes
    DefaultBSONHandlers
  30. implicit object BSONBinaryIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONBinary]
    Definition Classes
    BSONIdentityHandlers
  31. object BSONBoolean
  32. implicit object BSONBooleanHandler extends BSONHandler[Boolean] with SafeBSONWriter[Boolean]
    Definition Classes
    DefaultBSONHandlers
  33. implicit object BSONBooleanIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONBoolean]
    Definition Classes
    BSONIdentityHandlers
  34. object BSONBooleanLike
  35. object BSONDateTime
  36. implicit object BSONDateTimeHandler extends BSONHandler[Instant] with SafeBSONWriter[Instant]
    Definition Classes
    DefaultBSONHandlers
  37. implicit object BSONDateTimeIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONDateTime]
    Definition Classes
    BSONIdentityHandlers
  38. object BSONDecimal
  39. implicit object BSONDecimalHandler extends BSONHandler[BigDecimal]
    Definition Classes
    DefaultBSONHandlers
  40. implicit object BSONDecimalIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONDecimal]
    Definition Classes
    BSONIdentityHandlers
  41. object BSONDocument

    BSONDocument factories & utilities

  42. object BSONDocumentHandler

    Handler factory

  43. implicit object BSONDocumentIdentity extends BSONDocumentReader[BSONDocument] with BSONDocumentWriter[BSONDocument]
    Definition Classes
    BSONIdentityHandlers
  44. object BSONDocumentReader
  45. object BSONDocumentWriter
  46. object BSONDouble
  47. implicit object BSONDoubleHandler extends BSONHandler[Double] with SafeBSONWriter[Double]
    Definition Classes
    DefaultBSONHandlers
  48. implicit object BSONDoubleIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONDouble]
    Definition Classes
    BSONIdentityHandlers
  49. object BSONElement extends BSONElementLowPriority
  50. implicit object BSONFloatHandler extends BSONHandler[Float] with SafeBSONWriter[Float]
    Definition Classes
    DefaultBSONHandlers
  51. object BSONHandler
  52. object BSONInteger
  53. implicit object BSONIntegerHandler extends BSONHandler[Int] with SafeBSONWriter[Int]
    Definition Classes
    DefaultBSONHandlers
  54. implicit object BSONIntegerIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONInteger]
    Definition Classes
    BSONIdentityHandlers
  55. object BSONJavaScript
  56. implicit object BSONJavaScriptIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONJavaScript]
    Definition Classes
    BSONIdentityHandlers
  57. object BSONJavaScriptWS
  58. implicit object BSONJavaScriptWSIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONJavaScriptWS]
    Definition Classes
    BSONIdentityHandlers
  59. object BSONLong
  60. implicit object BSONLongHandler extends BSONHandler[Long] with SafeBSONWriter[Long]
    Definition Classes
    DefaultBSONHandlers
  61. implicit object BSONLongIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONLong]
    Definition Classes
    BSONIdentityHandlers
  62. object BSONMaxKey extends BSONMaxKey
  63. implicit object BSONMaxKeyIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONMaxKey]
    Definition Classes
    BSONIdentityHandlers
  64. object BSONMinKey extends BSONMinKey
  65. implicit object BSONMinKeyIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONMinKey]
    Definition Classes
    BSONIdentityHandlers
  66. object BSONNull extends BSONNull
  67. implicit object BSONNullIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONNull]
    Definition Classes
    BSONIdentityHandlers
  68. object BSONNumberLike
  69. object BSONObjectID
  70. implicit object BSONObjectIDIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONObjectID]
    Definition Classes
    BSONIdentityHandlers
  71. object BSONReader
  72. object BSONRegex
  73. implicit object BSONRegexIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONRegex]
    Definition Classes
    BSONIdentityHandlers
  74. object BSONString
  75. implicit object BSONStringHandler extends BSONHandler[String] with SafeBSONWriter[String]
    Definition Classes
    DefaultBSONHandlers
  76. implicit object BSONStringIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONString]
    Definition Classes
    BSONIdentityHandlers
  77. object BSONSymbol
  78. implicit object BSONSymbolIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONSymbol]
    Definition Classes
    BSONIdentityHandlers
  79. object BSONTimestamp

    Timestamp companion

  80. implicit object BSONTimestampIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONTimestamp]
    Definition Classes
    BSONIdentityHandlers
  81. implicit object BSONURIHandler extends BSONHandler[URI] with SafeBSONWriter[URI]
    Definition Classes
    DefaultBSONHandlers
  82. implicit object BSONURLHandler extends BSONHandler[URL] with SafeBSONWriter[URL]
    Definition Classes
    DefaultBSONHandlers
  83. object BSONUndefined extends BSONUndefined
  84. implicit object BSONUndefinedIdentity extends bson.DefaultBSONHandlers.IdentityBSONHandler[BSONUndefined]
    Definition Classes
    BSONIdentityHandlers
  85. object BSONValue extends BSONValueLowPriority1
  86. implicit object BSONValueIdentity extends BSONReader[BSONValue] with BSONWriter[BSONValue]
    Definition Classes
    BSONIdentityLowPriorityHandlers
  87. object BSONWriter
  88. object ElementProducer extends ElementProducerLowPriority
  89. object FieldNaming

    Naming companion

  90. object KeyReader
  91. object KeyWriter extends LowPriorityKeyWriter
  92. object MacroConfiguration
  93. object MacroOptions
  94. object Macros

    Macros for generating BSONReader and BSONWriter at compile time.

    Macros for generating BSONReader and BSONWriter at compile time.

    import reactivemongo.api.bson.Macros

case class Person(name: String, surname: String)

implicit val personHandler = Macros.handler[Person]
    See also

    MacroOptions for specific options

    MacroConfiguration for extended configuration

  95. object Subtype
  96. object TypeNaming
  97. object ¬
    Annotations
    @SuppressWarnings()

Inherited from Utils

Inherited from Aliases

Inherited from DefaultBSONHandlers

Inherited from BSONIdentityHandlers

Inherited from BSONIdentityLowPriorityHandlers

Inherited from LowPriority1BSONHandlers

Inherited from LowPriority2BSONHandlers

Inherited from LowPriority3BSONHandlers

Inherited from LowPriority4BSONHandlers

Inherited from LowPriorityBSONHandlersCompat

Inherited from AnyRef

Inherited from Any

Ungrouped