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 MacroOptions

    MacroOptions factories & utilities.

    MacroOptions factories & utilities.

    Definition Classes
    bson
  • AutomaticMaterialization
  • Default
  • DisableWarnings
  • ReadDefaultValues
  • UnionType
  • ValueOf
  • Verbose
  • \/

trait ReadDefaultValues extends Default

Considering a class property with a default value, when reading the class from BSON if there is no BSON value corresponding to the property, then the default value is used.

import reactivemongo.api.bson.{
  BSONDocument, BSONDocumentReader, Macros, MacroOptions
}

case class Foo(id: Int, title: String = "default")

val reader: BSONDocumentReader[Foo] =
  Macros.using[MacroOptions.ReadDefaultValues].reader[Foo]

reader.readTry(BSONDocument("id" -> 1))
// => Success: Foo(id = 1, title = "default")
Linear Supertypes
Default, MacroOptions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadDefaultValues
  2. Default
  3. MacroOptions
  4. AnyRef
  5. 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

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 ReadDefaultValues toany2stringadd[ReadDefaultValues] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ReadDefaultValues, B)
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toArrowAssoc[ReadDefaultValues] 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. def ensuring(cond: (ReadDefaultValues) => Boolean, msg: => Any): ReadDefaultValues
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toEnsuring[ReadDefaultValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ReadDefaultValues) => Boolean): ReadDefaultValues
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toEnsuring[ReadDefaultValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ReadDefaultValues
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toEnsuring[ReadDefaultValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ReadDefaultValues
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toEnsuring[ReadDefaultValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toStringFormat[ReadDefaultValues] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ReadDefaultValues, B)
    Implicit
    This member is added by an implicit conversion from ReadDefaultValues toArrowAssoc[ReadDefaultValues] 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 Default

Inherited from MacroOptions

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromReadDefaultValues to any2stringadd[ReadDefaultValues]

Inherited by implicit conversion StringFormat fromReadDefaultValues to StringFormat[ReadDefaultValues]

Inherited by implicit conversion Ensuring fromReadDefaultValues to Ensuring[ReadDefaultValues]

Inherited by implicit conversion ArrowAssoc fromReadDefaultValues to ArrowAssoc[ReadDefaultValues]

Ungrouped