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

  • object Annotations

    Annotations to use on case classes that are being processed by macros.

    Annotations to use on case classes that are being processed by macros.

    Definition Classes
    Macros
  • DefaultValue
  • Flatten
  • Ignore
  • Key
  • NoneAsNull
  • Reader
  • Writer

final class DefaultValue[T] extends Annotation with StaticAnnotation

Indicates a default value for a class property, when there is no corresponding BSON value when reading.

It enables a behaviour similar to MacroOptions.ReadDefaultValues, without requiring the define a global default value for the property.

import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.Macros,
  Macros.Annotations.DefaultValue

case class Foo(
  title: String,
  @DefaultValue(1.23D) score: Double)

val reader = Macros.reader[Foo]

reader.readTry(BSONDocument("title" -> "Bar")) // No BSON 'score'
// Success: Foo(title = "Bar", score = 1.23D)
Annotations
@param()
Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultValue
  2. StaticAnnotation
  3. Annotation
  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

Instance Constructors

  1. new DefaultValue(value: T)

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

Deprecated Value Members

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

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDefaultValue[T] to any2stringadd[DefaultValue[T]]

Inherited by implicit conversion StringFormat fromDefaultValue[T] to StringFormat[DefaultValue[T]]

Inherited by implicit conversion Ensuring fromDefaultValue[T] to Ensuring[DefaultValue[T]]

Inherited by implicit conversion ArrowAssoc fromDefaultValue[T] to ArrowAssoc[DefaultValue[T]]

Ungrouped