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] }
document ++ ("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 -D option).

    • 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).
    Definition Classes
    api
  • object BSONNumberLike

    BSONNumberLike utilities

    BSONNumberLike utilities

    Definition Classes
    bson
  • Handler

implicit object Handler extends BSONReader[BSONNumberLike] with BSONWriter[BSONNumberLike] with SafeBSONWriter[BSONNumberLike]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Handler
  2. SafeBSONWriter
  3. BSONWriter
  4. BSONReader
  5. AnyRef
  6. 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. def afterRead[U](f: (BSONNumberLike) => U): BSONReader[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
    BSONReader
  5. def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONWriter[BSONNumberLike]

    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
    BSONWriter
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONReader[BSONNumberLike]

    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
    BSONReader
  8. def beforeWrite[U](f: (U) => BSONNumberLike): BSONWriter[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

    Definition Classes
    BSONWriter
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def readOpt(bson: BSONValue): Option[BSONNumberLike]

    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
    Handler → BSONReader
  20. def readOrElse(bson: BSONValue, default: => BSONNumberLike): BSONNumberLike

    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
  21. def readTry(bson: BSONValue): Try[BSONNumberLike]

    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
    Handler → BSONReader
  22. def safeWrite(n: BSONNumberLike): BSONValue
    Definition Classes
    Handler → SafeBSONWriter
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  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()
  28. def widen[U >: BSONNumberLike]: BSONReader[U]

    Widen this read for compatible type U.

    Widen this read for 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
    BSONReader
  29. def writeOpt(t: BSONNumberLike): Option[BSONValue]

    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.

    Definition Classes
    BSONWriter
  30. final def writeTry(value: BSONNumberLike): Success[BSONValue]
    Definition Classes
    SafeBSONWriter

Inherited from SafeBSONWriter[BSONNumberLike]

Inherited from BSONWriter[BSONNumberLike]

Inherited from BSONReader[BSONNumberLike]

Inherited from AnyRef

Inherited from Any

Ungrouped