reactivemongo-bson-api < Back

Packages

package root
Definition Classes
root
package reactivemongo
Definition Classes
root
package api
Definition Classes
reactivemongo

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

package exceptions
Definition Classes
bson
BSON
BSONArray
BSONArrayCollectionReader
BSONArrayCollectionWriter
BSONBinary
BSONBinaryHandler
BSONBoolean
BSONBooleanHandler
BSONBooleanLike
BSONByteHandler
BSONCharHandler
BSONDateTime
BSONDateTimeHandler
BSONDecimal
BSONDecimalHandler
BSONDocument
BSONDocumentHandler
BSONDocumentReader
BSONDocumentWriter
BSONDouble
BSONDoubleHandler
BSONElement
BSONFloatHandler
BSONHandler
BSONInteger
BSONIntegerHandler
BSONJavaScript
BSONJavaScriptWS
BSONLocalDateHandler
BSONLocalDateTimeHandler
BSONLocalTimeHandler
BSONLocaleHandler
BSONLong
BSONLongHandler
BSONMaxKey
BSONMinKey
BSONNull
BSONNumberLike
BSONObjectID
BSONOffsetDateTimeHandler
BSONReader
BSONRegex
BSONShortHandler
BSONStrictDocument
BSONString
BSONStringHandler
BSONSymbol
BSONTimestamp
BSONURIHandler
BSONURLHandler
BSONUUIDHandler
BSONUndefined
BSONValue
BSONValueIdentity
BSONWriter
BSONZonedDateTimeHandler
DocumentClass
ElementProducer
FieldNaming
KeyReader
KeyWriter
MacroConfiguration
MacroOptions
Macros
Producer
Subtype
TypeNaming
¬

reactivemongo.api.bson

BSONUndefined

Companion trait BSONUndefined

object BSONUndefined extends BSONUndefined

Single value for BSONUndefined type

Linear Supertypes

BSONUndefined, Value, BSONBooleanLike, BSONValue, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

BSONUndefined
BSONUndefined
Value
BSONBooleanLike
BSONValue
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def asOpt[T](implicit reader: BSONReader[T]): Option[T]
Optionally parses this value as a T one.
Optionally parses this value as a T one.
returns
Some successfully parsed value, or None if fails
```
import reactivemongo.api.bson.BSONValue

def foo(v: BSONValue): Option[String] = v.asOpt[String]
```
Definition Classes
BSONValue
Annotations
@inline()
final def asTry[T](implicit reader: BSONReader[T]): Try[T]
Tries to parse this value as a T one.
Tries to parse this value as a T one.
```
import scala.util.Try
import reactivemongo.api.bson.BSONValue

def foo(v: BSONValue): Try[String] = v.asTry[String]
```
Definition Classes
BSONValue
val byteCode: Byte
The code indicating the BSON type for this value as Byte
The code indicating the BSON type for this value as Byte
Definition Classes
BSONUndefined → BSONValue
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
val code: Int
The code indicating the BSON type for this value
The code indicating the BSON type for this value
Definition Classes
BSONUndefined → BSONValue
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
val pretty: String
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
val toBoolean: Success[Boolean]
Returns the boolean equivalent value
Returns the boolean equivalent value
Definition Classes
BSONUndefined → BSONBooleanLike
def toString(): String
Definition Classes
BSONUndefined → AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

BSONUndefined

Companion trait BSONUndefined

object BSONUndefined extends BSONUndefined

Value Members

Inherited from BSONUndefined

Inherited from Value

Inherited from BSONBooleanLike

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

BSONUndefined

Companion trait BSONUndefined

object BSONUndefined extends BSONUndefined

Value Members

Inherited from BSONUndefined

Inherited from Value

Inherited from BSONBooleanLike

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Ungrouped

BSONUndefined