Packages

package bson

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. bson
  2. DefaultBSONHandlers
  3. LowPrioBSONHandlers
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package buffer
  2. package exceptions
  3. package lowlevel
  4. package utils

Type Members

  1. case class BSONArray(stream: Stream[Try[BSONValue]]) extends BSONValue with BSONElementSet with Product with Serializable

    A BSONArray structure (BSON type 0x04).

    A BSONArray structure (BSON type 0x04).

    A BSONArray is a straightforward BSONDocument where keys are a sequence of positive integers.

    A BSONArray is basically a stream of tuples (String, BSONValue) where the first member is a string representation of an index. It is completely lazy. The stream it wraps is a Stream[Try[(String, BSONValue)]] since we cannot be sure that a not yet deserialized value will be processed without error.

  2. class BSONArrayBenchmark extends AnyRef
    Annotations
    @State()
  3. class BSONArrayHandlerBenchmark extends AnyRef
    Annotations
    @State()
  4. case class BSONBinary(value: ReadableBuffer, subtype: Subtype) extends BSONValue with Product with Serializable

    A BSON binary value.

    A BSON binary value.

    value

    The binary content.

    subtype

    The type of the binary content.

  5. class BSONBinaryHandlerBenchmark extends HandlerBenchmark[BSONBinary]
    Annotations
    @State()
  6. class BSONBinarySerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  7. class BSONBinaryUUIDBenchmark extends AnyRef
    Annotations
    @State()
  8. case class BSONBoolean(value: Boolean) extends BSONValue with Product with Serializable

    BSON boolean value

  9. class BSONBooleanHandlerBenchmark extends HandlerBenchmark[BSONBoolean]
    Annotations
    @State()
  10. 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
  11. sealed trait BSONBooleanLikeClass[B <: BSONValue] extends BSONBooleanLike
  12. class BSONBooleanLikeHandlerBenchmark extends AnyRef
    Annotations
    @State()
  13. class BSONBooleanSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  14. class BSONDBPointer extends BSONValue

    BSON DBPointer value.

  15. case class BSONDateTime(value: Long) extends BSONValue with Product with Serializable

    BSON date time value

  16. class BSONDateTimeHandlerBenchmark extends HandlerBenchmark[BSONDateTime]
    Annotations
    @State()
  17. class BSONDateTimeSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  18. final class BSONDecimal extends BSONValue with Product2[Long, Long]

    Value wrapper for a BSON 128-bit decimal.

    Value wrapper for a BSON 128-bit decimal.

    Annotations
    @SerialVersionUID()
  19. class BSONDecimalHandlerBenchmark extends HandlerBenchmark[BSONDecimal]
    Annotations
    @State()
  20. class BSONDecimalSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  21. case class BSONDocument(stream: Stream[Try[BSONElement]]) extends BSONValue with BSONElementSet with Product with Serializable

    A BSONDocument structure (BSON type 0x03).

    A BSONDocument structure (BSON type 0x03).

    A BSONDocument is basically a stream of tuples (String, BSONValue). It is completely lazy. The stream it wraps is a Stream[Try[(String, BSONValue)]] since we cannot be sure that a not yet deserialized value will be processed without error.

  22. class BSONDocumentBenchmark extends AnyRef
    Annotations
    @State()
  23. type BSONDocumentHandler[T] = BSONDocumentReader[T] with BSONDocumentWriter[T] with BSONHandler[BSONDocument, T]

    Convenient type alias for document handlers

  24. class BSONDocumentHandlerBenchmark extends AnyRef
    Annotations
    @State()
  25. trait BSONDocumentReader[T] extends BSONReader[BSONDocument, T]
  26. class BSONDocumentSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  27. trait BSONDocumentWriter[T] extends BSONWriter[T, BSONDocument]
  28. case class BSONDouble(value: Double) extends BSONValue with Product with Serializable

    A BSON Double.

  29. class BSONDoubleHandlerBenchmark extends HandlerBenchmark[BSONDouble]
    Annotations
    @State()
  30. class BSONDoubleSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  31. case class BSONElement(name: String, value: BSONValue) extends ElementProducer with Product with Serializable
  32. class BSONElementBenchmark extends AnyRef
    Annotations
    @State()
  33. sealed trait BSONElementLowPriority extends AnyRef
  34. sealed trait BSONElementSet extends ElementProducer

    Operations for a BSONElement that can contain multiple nested elements.

  35. trait BSONHandler[B <: BSONValue, T] extends BSONReader[B, T] with BSONWriter[T, B]
  36. case class BSONInteger(value: Int) extends BSONValue with Product with Serializable

    BSON Integer value

  37. class BSONIntegerHandlerBenchmark extends HandlerBenchmark[BSONInteger]
    Annotations
    @State()
  38. class BSONIntegerSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  39. sealed trait BSONIterator extends Iterator[(String, BSONValue)]
  40. case class BSONJavaScript(value: String) extends BSONValue with Product with Serializable

    BSON JavaScript value.

    BSON JavaScript value.

    value

    The JavaScript source code.

  41. case class BSONJavaScriptWS(value: String) extends BSONValue with Product with Serializable

    BSON scoped JavaScript value.

    BSON scoped JavaScript value.

    value

    The JavaScript source code.

  42. class BSONJavascriptSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  43. class BSONJavascriptWsSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  44. case class BSONLong(value: Long) extends BSONValue with Product with Serializable

    BSON Long value

  45. class BSONLongHandlerBenchmark extends HandlerBenchmark[BSONLong]
    Annotations
    @State()
  46. class BSONLongSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  47. sealed trait BSONNumberLike extends AnyRef

    A BSON value that can be seen as a number.

    A BSON value that can be seen as a number.

    Conversions:

  48. sealed trait BSONNumberLikeClass[B <: BSONValue] extends BSONNumberLike
  49. class BSONNumberLikeHandlerBenchmark extends AnyRef
    Annotations
    @State()
  50. class BSONObjectID extends BSONValue with Serializable with Equals

    BSON ObjectId value.

    BSON ObjectId value.

    +------------------------+------------------------+------------------------+------------------------+ + timestamp (in seconds) + machine identifier + thread identifier + increment + + (4 bytes) + (3 bytes) + (2 bytes) + (3 bytes) + +------------------------+------------------------+------------------------+------------------------+

    Annotations
    @SerialVersionUID()
  51. class BSONObjectIDSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  52. trait BSONReader[B <: BSONValue, T] extends AnyRef

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

  53. case class BSONRegex(value: String, flags: String) extends BSONValue with Product with Serializable

    BSON Regex value.

    BSON Regex value.

    flags

    Regex flags.

  54. class BSONRegexSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  55. case class BSONString(value: String) extends BSONValue with Product with Serializable
  56. class BSONStringHandlerBenchmark extends HandlerBenchmark[BSONString]
    Annotations
    @State()
  57. class BSONStringSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  58. case class BSONSymbol(value: String) extends BSONValue with Product with Serializable

    BSON Symbol value.

  59. case class BSONTimestamp(value: Long) extends BSONValue with Product with Serializable

    BSON Timestamp value

  60. class BSONTimestampBenchmark extends AnyRef
    Annotations
    @State()
  61. class BSONTimestampSerializationBenchmark extends SerializationBenchmark
    Annotations
    @State()
  62. sealed trait BSONValue extends AnyRef
  63. trait BSONWriter[T, B <: BSONValue] extends AnyRef

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

  64. trait DefaultBSONHandlers extends LowPrioBSONHandlers
  65. class BSONBooleanLikeReader[B <: BSONValue] extends BSONReader[B, BSONBooleanLike]
    Definition Classes
    DefaultBSONHandlers
  66. class BSONNumberLikeReader[B <: BSONValue] extends BSONReader[B, BSONNumberLike]
    Definition Classes
    DefaultBSONHandlers
  67. abstract class IdentityBSONConverter[T <: BSONValue] extends BSONReader[T, T] with BSONWriter[T, T]
    Definition Classes
    DefaultBSONHandlers
  68. sealed trait ElementProducer extends Producer[BSONElement]
  69. sealed trait HandlerBenchmark[B <: BSONValue] extends AnyRef
  70. trait LowPrioBSONHandlers extends AnyRef
  71. class BSONArrayCollectionReader[M[_], T] extends BSONReader[BSONArray, M[T]]
    Definition Classes
    LowPrioBSONHandlers
  72. class BSONArrayCollectionWriter[T, Repr] extends VariantBSONWriter[Repr, BSONArray]
    Definition Classes
    LowPrioBSONHandlers
  73. sealed trait Producer[T] extends AnyRef
  74. class ReadableBufferBenchmark extends AnyRef
    Annotations
    @State()
  75. sealed trait SerializationBenchmark extends AnyRef
  76. sealed trait Subtype extends AnyRef

    Binary Subtype

  77. sealed trait UnsafeBSONReader[T] extends AnyRef
  78. trait VariantBSONDocumentReader[+T] extends VariantBSONReader[BSONDocument, T]
  79. trait VariantBSONDocumentWriter[-T] extends VariantBSONWriter[T, BSONDocument]
  80. trait VariantBSONReader[-B <: BSONValue, +T] extends AnyRef

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

  81. class VariantBSONReaderWrapper[B <: BSONValue, T] extends BSONReader[B, T]
  82. trait VariantBSONWriter[-T, +B <: BSONValue] extends AnyRef

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

  83. class VariantBSONWriterWrapper[T, B <: BSONValue] extends BSONWriter[T, B]
  84. class WritableBufferBenchmark extends AnyRef
    Annotations
    @State()

Value Members

  1. def BSONDocumentHandler[T](read: (BSONDocument) => T, write: (T) => BSONDocument): BSONDocumentHandler[T]

    Handler factory

  2. implicit def MapReader[K, V](implicit keyReader: BSONReader[BSONString, K], valueReader: BSONReader[_ <: BSONValue, V]): BSONDocumentReader[Map[K, V]]
    Definition Classes
    DefaultBSONHandlers
  3. implicit def MapWriter[K, V](implicit keyWriter: BSONWriter[K, BSONString], valueWriter: BSONWriter[V, _ <: BSONValue]): BSONDocumentWriter[Map[K, V]]
    Definition Classes
    DefaultBSONHandlers
  4. def array(values: Producer[BSONValue]*): BSONArray

    Returns an array with given values.

  5. def array: BSONArray

    Returns an empty array.

  6. implicit def bsonArrayToCollectionReader[M[_], T](implicit cbf: Factory[T, M[T]], reader: BSONReader[_ <: BSONValue, T]): BSONReader[BSONArray, M[T]]
    Definition Classes
    LowPrioBSONHandlers
  7. implicit def bsonBooleanLikeReader[B <: BSONValue]: BSONBooleanLikeReader[B]
    Definition Classes
    DefaultBSONHandlers
  8. implicit def bsonNumberLikeReader[B <: BSONValue]: BSONNumberLikeReader[B]
    Definition Classes
    DefaultBSONHandlers
  9. implicit def collectionToBSONArrayCollectionWriter[T, Repr](implicit arg0: (Repr) => Iterable[T], writer: BSONWriter[T, _ <: BSONValue]): VariantBSONWriter[Repr, BSONArray]
    Definition Classes
    LowPrioBSONHandlers
  10. def document(elements: Producer[BSONElement]*): BSONDocument

    Returns a document with given elements.

  11. def document: BSONDocument

    Returns an empty document.

  12. def element(name: String, value: BSONValue): BSONElement
  13. implicit def findWriter[T](implicit writer: VariantBSONWriter[T, _ <: BSONValue]): BSONWriter[T, _ <: BSONValue]
    Definition Classes
    DefaultBSONHandlers
  14. def generateId: BSONObjectID

    Returns a newly generated object ID.

  15. object BSON
  16. object BSONArray extends Serializable
  17. object BSONArrayBenchmark
  18. object BSONBinary extends Serializable
  19. object BSONBooleanLike
  20. object BSONDBPointer
  21. object BSONDecimal
  22. object BSONDocument extends Serializable
  23. object BSONDocumentBenchmark
  24. object BSONDocumentReader
  25. object BSONDocumentWriter
  26. object BSONElement extends BSONElementLowPriority with Serializable
  27. object BSONElementSet
  28. object BSONHandler
  29. object BSONIterator
  30. object BSONMaxKey extends BSONValue

    BSON Max key value

  31. object BSONMinKey extends BSONValue

    BSON Min key value

  32. object BSONNull extends BSONValue with Product with Serializable

    BSON null value

  33. object BSONNumberLike
  34. object BSONObjectID extends Serializable
  35. object BSONReader
  36. object BSONTimestamp extends Serializable

    Timestamp companion

  37. object BSONUndefined extends BSONValue with Product with Serializable

    BSON Undefined value

  38. object BSONValue
  39. object BSONWriter
  40. object DefaultBSONHandlers extends DefaultBSONHandlers
  41. implicit object BSONArrayIdentity extends IdentityBSONConverter[BSONArray]
    Definition Classes
    DefaultBSONHandlers
  42. implicit object BSONBinaryHandler extends BSONHandler[BSONBinary, Array[Byte]]
    Definition Classes
    DefaultBSONHandlers
  43. implicit object BSONBinaryIdentity extends IdentityBSONConverter[BSONBinary]
    Definition Classes
    DefaultBSONHandlers
  44. implicit object BSONBooleanHandler extends BSONHandler[BSONBoolean, Boolean]
    Definition Classes
    DefaultBSONHandlers
  45. implicit object BSONBooleanIdentity extends IdentityBSONConverter[BSONBoolean]
    Definition Classes
    DefaultBSONHandlers
  46. implicit object BSONBooleanLikeWriter extends VariantBSONWriter[BSONBooleanLike, BSONValue]
    Definition Classes
    DefaultBSONHandlers
  47. implicit object BSONDateTimeHandler extends BSONHandler[BSONDateTime, Date]
    Definition Classes
    DefaultBSONHandlers
  48. implicit object BSONDateTimeIdentity extends IdentityBSONConverter[BSONDateTime]
    Definition Classes
    DefaultBSONHandlers
  49. implicit object BSONDecimalHandler extends BSONHandler[BSONDecimal, BigDecimal]
    Definition Classes
    DefaultBSONHandlers
  50. implicit object BSONDecimalIdentity extends IdentityBSONConverter[BSONDecimal]
    Definition Classes
    DefaultBSONHandlers
  51. implicit object BSONDocumentIdentity extends IdentityBSONConverter[BSONDocument] with BSONDocumentReader[BSONDocument] with BSONDocumentWriter[BSONDocument]
    Definition Classes
    DefaultBSONHandlers
  52. implicit object BSONDoubleHandler extends BSONHandler[BSONDouble, Double]
    Definition Classes
    DefaultBSONHandlers
  53. implicit object BSONDoubleIdentity extends IdentityBSONConverter[BSONDouble]
    Definition Classes
    DefaultBSONHandlers
  54. implicit object BSONIntegerHandler extends BSONHandler[BSONInteger, Int]
    Definition Classes
    DefaultBSONHandlers
  55. implicit object BSONIntegerIdentity extends IdentityBSONConverter[BSONInteger]
    Definition Classes
    DefaultBSONHandlers
  56. implicit object BSONJavaScriptIdentity extends BSONReader[BSONJavaScript, BSONJavaScript] with BSONWriter[BSONJavaScript, BSONJavaScript]
    Definition Classes
    DefaultBSONHandlers
  57. implicit object BSONLongHandler extends BSONHandler[BSONLong, Long]
    Definition Classes
    DefaultBSONHandlers
  58. implicit object BSONLongIdentity extends IdentityBSONConverter[BSONLong]
    Definition Classes
    DefaultBSONHandlers
  59. implicit object BSONNullIdentity extends IdentityBSONConverter[BSONNull.type]
    Definition Classes
    DefaultBSONHandlers
  60. implicit object BSONNumberLikeWriter extends VariantBSONWriter[BSONNumberLike, BSONValue]
    Definition Classes
    DefaultBSONHandlers
  61. implicit object BSONObjectIDIdentity extends IdentityBSONConverter[BSONObjectID]
    Definition Classes
    DefaultBSONHandlers
  62. implicit object BSONRegexIdentity extends IdentityBSONConverter[BSONRegex]
    Definition Classes
    DefaultBSONHandlers
  63. implicit object BSONStringHandler extends BSONHandler[BSONString, String]
    Definition Classes
    DefaultBSONHandlers
  64. implicit object BSONStringIdentity extends IdentityBSONConverter[BSONString]
    Definition Classes
    DefaultBSONHandlers
  65. implicit object BSONUndefinedIdentity extends IdentityBSONConverter[BSONUndefined.type]
    Definition Classes
    DefaultBSONHandlers
  66. implicit object BSONValueIdentity extends IdentityBSONConverter[BSONValue]
    Definition Classes
    DefaultBSONHandlers
  67. object ElementProducer
  68. object Macros

    Macros for generating BSONReader and BSONWriter implementations for case at compile time.

    Macros for generating BSONReader and BSONWriter implementations for case at compile time. Invoking these macros is equivalent to writing anonymous class implementations by hand.

    import reactivemongo.bson.Macros

case class Person(name: String, surname: String)
implicit val personHandler = Macros.handler[Person]
    See also

    Macros.Options for specific options

  69. object Producer
  70. object Subtype