Packages

  • package root
    Definition Classes
    root
  • package reactivemongo
    Definition Classes
    root
  • package api
    Definition Classes
    reactivemongo
  • package bson

    BSON main API

    BSON main API

    import reactivemongo.api.bson._
    
    // { "name": "Johny", "surname": "Doe", "age": 28, "months": [1, 2, 3] }
    BSONDocument.empty ++ ("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)))

    System properties:

    The following properties can be set (e.g. using JVM -D options).

    • reactivemongo.api.bson.bufferSizeBytes (integer; default: 96): Number of bytes used as initial size when allocating a new buffer.
    • reactivemongo.api.bson.document.strict (boolean; default: false): Flag to enable strict reading of document (filter duplicate fields, see BSONDocument.asStrict).
    Definition Classes
    api
  • 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]
    Definition Classes
    bson
    See also

    MacroOptions for specific options

    MacroConfiguration for extended configuration

  • Annotations
  • LocalVar
  • Placeholder
  • WithOptions

final class WithOptions[Opts <: MacroOptions] extends AnyRef

Macros for generating BSONReader and BSONWriter at compile time, with given options.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WithOptions
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WithOptions()
  2. new WithOptions(config: Aux[Opts])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toany2stringadd[WithOptions[Opts]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WithOptions[Opts], B)
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toArrowAssoc[WithOptions[Opts]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val config: Aux[Opts]
  9. def ensuring(cond: (WithOptions[Opts]) => Boolean, msg: => Any): WithOptions[Opts]
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toEnsuring[WithOptions[Opts]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (WithOptions[Opts]) => Boolean): WithOptions[Opts]
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toEnsuring[WithOptions[Opts]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): WithOptions[Opts]
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toEnsuring[WithOptions[Opts]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): WithOptions[Opts]
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toEnsuring[WithOptions[Opts]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toStringFormat[WithOptions[Opts]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. macro def handler[A]: BSONDocumentHandler[A]

    Creates a BSONDocumentHandler for type A.

    Creates a BSONDocumentHandler for type A.

    A

    the type of the value represented as BSON

    Annotations
    @SuppressWarnings()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. macro def reader[A]: BSONDocumentReader[A]

    Creates a BSONDocumentReader for type A.

    Creates a BSONDocumentReader for type A.

    A

    the type of the value represented as BSON

    Annotations
    @SuppressWarnings()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. macro def writer[A]: BSONDocumentWriter[A]

    Creates a BSONDocumentWriter for type A.

    Creates a BSONDocumentWriter for type A.

    A

    the type of the value represented as BSON

    Annotations
    @SuppressWarnings()

Deprecated Value Members

  1. def [B](y: B): (WithOptions[Opts], B)
    Implicit
    This member is added by an implicit conversion from WithOptions[Opts] toArrowAssoc[WithOptions[Opts]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWithOptions[Opts] to any2stringadd[WithOptions[Opts]]

Inherited by implicit conversion StringFormat fromWithOptions[Opts] to StringFormat[WithOptions[Opts]]

Inherited by implicit conversion Ensuring fromWithOptions[Opts] to Ensuring[WithOptions[Opts]]

Inherited by implicit conversion ArrowAssoc fromWithOptions[Opts] to ArrowAssoc[WithOptions[Opts]]

Ungrouped