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 Placeholder

    Only for internal purposes

    Only for internal purposes

    Definition Classes
    Macros
  • Handler

implicit object Handler extends BSONDocumentHandler[Placeholder]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Handler
  2. BSONDocumentHandler
  3. BSONHandler
  4. BSONDocumentWriter
  5. BSONWriter
  6. BSONDocumentReader
  7. BSONReader
  8. AnyRef
  9. Any
  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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def afterRead[U](f: (Placeholder) => U): BSONDocumentReader[U]

    Prepares a BSONReader that returns the result of applying f on the result of this reader.

    Prepares a BSONReader that returns the result of applying f on the result of this reader.

    import scala.util.Try
import reactivemongo.api.bson.{ BSONReader, BSONValue }

// Try to return an integer + 1,
// from any T that can be read from BSON
// and is a numeric type
def fromBSON[T](bson: BSONValue)(
  implicit r: BSONReader[T], n: Numeric[T]): Try[Int] = {
  val r2: BSONReader[Int] = r.afterRead { v => n.toInt(v) + 1 }
 r2.readTry(bson)
}
    f

    the function to apply

    Definition Classes
    BSONDocumentReader → BSONReader
  5. final def afterWrite(f: (BSONDocument) => BSONDocument): BSONDocumentHandler[Placeholder]
    Definition Classes
    BSONDocumentHandler → BSONDocumentWriter
  6. final def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[Placeholder]

    Prepares a BSON writer that returns the result of applying f on the BSON value from this writer.

    Prepares a BSON writer that returns the result of applying f on the BSON value from this writer.

    If the f function is not defined for a BSONValue, it will results in a Failure.

    f

    the partial function to apply

    Definition Classes
    BSONHandler → BSONWriter
  7. final def as[R](to: (Placeholder) => R, from: (R) => Placeholder): BSONHandler[R]
    Definition Classes
    BSONHandler
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final def beforeRead(f: (BSONDocument) => BSONDocument): BSONDocumentHandler[Placeholder]
    Definition Classes
    BSONDocumentHandler → BSONDocumentReader
  10. final def beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[Placeholder]

    Prepares a BSONReader that transforms the input BSON value, using the given f function, before passing the transformed BSON value to the current reader.

    Prepares a BSONReader that transforms the input BSON value, using the given f function, before passing the transformed BSON value to the current reader.

    import reactivemongo.api.bson.{
  BSONReader, BSONInteger, BSONNull, BSONString
}

val normalizingReader: BSONReader[Int] =
  implicitly[BSONReader[Int]].beforeRead {
    case BSONNull => BSONInteger(-1)
    case BSONString(s) => BSONInteger(s.size)
    // other values are unchanged
  }

normalizingReader.readOpt(BSONNull) // Some(-1)
normalizingReader.readTry(BSONString("foo")) // Success(3)
normalizingReader.readOpt(BSONInteger(4)) // unchanged: Some(4)
    Definition Classes
    BSONHandler → BSONReader
  11. final def beforeWrite[U](f: (U) => Placeholder): BSONDocumentWriter[U]

    Prepares a BSON writer that converts the input before calling the current writer.

    Prepares a BSON writer that converts the input before calling the current writer.

    f

    the function apply the U input value to convert at T value used to the current writer

    import reactivemongo.api.bson.BSONWriter

val w: BSONWriter[String] =
  implicitly[BSONWriter[Int]].beforeWrite(_.size)

w.writeTry("foo") // Success: BSONInteger(3)
    Definition Classes
    BSONDocumentWriter → BSONWriter
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def narrow[U <: Placeholder]: BSONDocumentHandler[U]

    Narrows this writer for a compatible type U.

    Narrows this writer for a compatible type U.

    import reactivemongo.api.bson.BSONWriter

val listWriter: BSONWriter[Seq[String]] =
  implicitly[BSONWriter[Seq[String]]]

val narrowAsListWriter: BSONWriter[List[String]] =
  listWriter.narrow[List[String]]
  // as List[String] <: Seq[String]
    U

    must be a sub-type of T

    Definition Classes
    BSONDocumentHandler → BSONHandler → BSONDocumentWriter → BSONWriter
    Annotations
    @SuppressWarnings()
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def readDocument(bson: BSONDocument): Success[Placeholder]

    Tries to produce an instance of T from the document.

    Tries to produce an instance of T from the document.

    import scala.util.Try
import reactivemongo.api.bson.{ BSONDocument, BSONDocumentReader }

def fromBSON[T](document: BSONDocument)(
  implicit r: BSONDocumentReader[T]): Try[T] = r.readTry(document)
    Definition Classes
    Handler → BSONDocumentReader
  24. def readOpt(bson: BSONValue): Option[Placeholder]

    Tries to produce an instance of T from the bson value, returns None if an error occurred.

    Tries to produce an instance of T from the bson value, returns None if an error occurred.

    import reactivemongo.api.bson.{ BSONReader, BSONValue }

def fromBSON[T](bson: BSONValue)(implicit r: BSONReader[T]): Option[T] =
  r.readOpt(bson)
    Definition Classes
    BSONReader
  25. def readOrElse(bson: BSONValue, default: => Placeholder): Placeholder

    Tries to produce an instance of T from the bson value, returns the default value if an error occurred.

    Tries to produce an instance of T from the bson value, returns the default value if an error occurred.

    import reactivemongo.api.bson.{ BSONReader, BSONValue }

def fromBSON[T](bson: BSONValue, v: T)(implicit r: BSONReader[T]): T =
  r.readOrElse(bson, v)
    Definition Classes
    BSONReader
  26. final def readTry(bson: BSONValue): Try[Placeholder]

    Tries to produce an instance of T from the bson value.

    Tries to produce an instance of T from the bson value.

    import scala.util.Try
import reactivemongo.api.bson.{ BSONReader, BSONValue }

def fromBSON[T](bson: BSONValue)(implicit r: BSONReader[T]): Try[T] =
  r.readTry(bson)
    Definition Classes
    BSONDocumentReader → BSONReader
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def widen[U >: Placeholder]: BSONDocumentHandler[U]

    Widens this reader for a compatible type U.

    Widens this reader for a compatible type U.

    import reactivemongo.api.bson.BSONReader

val listReader: BSONReader[List[String]] =
  implicitly[BSONReader[List[String]]]

val widenAsSeqReader: BSONReader[Seq[String]] =
  listReader.widen[Seq[String]]
  // as Seq[String] >: List[String]
    U

    must be a super-type of T

    Definition Classes
    BSONDocumentHandler → BSONHandler → BSONDocumentReader → BSONReader
    Annotations
    @SuppressWarnings()
  33. def writeOpt(t: Placeholder): Option[BSONDocument]

    Tries to produce a BSON value from an instance of T, returns None if an error occurred.

    Tries to produce a BSON value from an instance of T, returns None if an error occurred.

    import reactivemongo.api.bson.{ BSONWriter, BSONValue }

def maybeBSON[T](value: T)(implicit w: BSONWriter[T]): Option[BSONValue] =
  w.writeOpt(value)
    Definition Classes
    BSONDocumentWriter → BSONWriter
  34. def writeTry(pl: Placeholder): Success[BSONDocument]

    Tries to produce a BSON value from an instance of T.

    Tries to produce a BSON value from an instance of T.

    import scala.util.Try
import reactivemongo.api.bson.{ BSONWriter, BSONValue }

def toBSON[T](value: T)(implicit w: BSONWriter[T]): Try[BSONValue] =
  w.writeTry(value)
    Definition Classes
    Handler → BSONDocumentWriter → BSONWriter
    Annotations
    @silent()

Inherited from BSONDocumentHandler[Placeholder]

Inherited from BSONHandler[Placeholder]

Inherited from BSONDocumentWriter[Placeholder]

Inherited from BSONWriter[Placeholder]

Inherited from BSONDocumentReader[Placeholder]

Inherited from BSONReader[Placeholder]

Inherited from AnyRef

Inherited from Any

Ungrouped