bson

Type Members

case class BSONArray(stream: Stream[Try[BSONValue]]) extends BSONValue with BSONElementSet with Product with Serializable

A BSONArray structure (BSON type 0x04).
A BSONArray structure (BSON type 0x04).
A BSONArray is a straightforward BSONDocument where keys are a sequence of positive integers.
A BSONArray is basically a stream of tuples (String, BSONValue) where the first member is a string representation of an index. It is completely lazy. The stream it wraps is a Stream[Try[(String, BSONValue)]] since we cannot be sure that a not yet deserialized value will be processed without error.
class BSONArrayCollectionReader[M[_], T] extends BSONReader[BSONArray, M[T]]

Definition Classes
DefaultBSONHandlers
class BSONArrayCollectionWriter[T, Repr] extends VariantBSONWriter[Repr, BSONArray]

Definition Classes
DefaultBSONHandlers
case class BSONBinary(value: ReadableBuffer, subtype: Subtype) extends BSONValue with Product with Serializable

A BSON binary value.
A BSON binary value.
value
The binary content.
subtype
The type of the binary content.
case class BSONBoolean(value: Boolean) extends BSONValue with Product with Serializable

BSON boolean value
sealed trait BSONBooleanLike extends AnyRef

A BSON value that can be seen as a boolean.
A BSON value that can be seen as a boolean.
Conversions:
- number = 0 ~> false
- number != 0 ~> true
- boolean
- undefined ~> false
- null ~> false
sealed trait BSONBooleanLikeClass[B <: BSONValue] extends BSONBooleanLike
class BSONBooleanLikeReader[B <: BSONValue] extends BSONReader[B, BSONBooleanLike]

Definition Classes
DefaultBSONHandlers
class BSONDBPointer extends BSONValue with Product with Serializable with Serializable

BSON DBPointer value.
case class BSONDateTime(value: Long) extends BSONValue with Product with Serializable

BSON date time value
case class BSONDocument(stream: Stream[Try[BSONElement]]) extends BSONValue with BSONElementSet with Product with Serializable

A BSONDocument structure (BSON type 0x03).
A BSONDocument structure (BSON type 0x03).
A BSONDocument is basically a stream of tuples (String, BSONValue). It is completely lazy. The stream it wraps is a Stream[Try[(String, BSONValue)]] since we cannot be sure that a not yet deserialized value will be processed without error.
type BSONDocumentHandler[T] = BSONDocumentReader[T] with BSONDocumentWriter[T] with BSONHandler[BSONDocument, T]

Convenient type alias for document handlers
trait BSONDocumentReader[T] extends BSONReader[BSONDocument, T]
trait BSONDocumentWriter[T] extends BSONWriter[T, BSONDocument]
case class BSONDouble(value: Double) extends BSONValue with Product with Serializable

A BSON Double.
case class BSONElement(name: String, value: BSONValue) extends ElementProducer with Product with Serializable
sealed trait BSONElementLowPriority extends AnyRef
sealed trait BSONElementSet extends ElementProducer

Operations for a BSONElement that can contain multiple nested elements.
trait BSONHandler[B <: BSONValue, T] extends BSONReader[B, T] with BSONWriter[T, B]
case class BSONInteger(value: Int) extends BSONValue with Product with Serializable

BSON Integer value
case class BSONJavaScript(value: String) extends BSONValue with Product with Serializable

BSON JavaScript value.
BSON JavaScript value.
value
The JavaScript source code.
case class BSONJavaScriptWS(value: String) extends BSONValue with Product with Serializable

BSON scoped JavaScript value.
BSON scoped JavaScript value.
value
The JavaScript source code. TODO
case class BSONLong(value: Long) extends BSONValue with Product with Serializable

BSON Long value
sealed trait BSONNumberLike extends AnyRef

A BSON value that can be seen as a number.
A BSON value that can be seen as a number.
Conversions:
sealed trait BSONNumberLikeClass[B <: BSONValue] extends BSONNumberLike
class BSONNumberLikeReader[B <: BSONValue] extends BSONReader[B, BSONNumberLike]

Definition Classes
DefaultBSONHandlers
class BSONObjectID extends BSONValue with Serializable with Equals

BSON ObjectId value.
BSON ObjectId value.
+------------------------+------------------------+------------------------+------------------------+ + timestamp (in seconds) + machine identifier + thread identifier + increment + + (4 bytes) + (3 bytes) + (2 bytes) + (3 bytes) + +------------------------+------------------------+------------------------+------------------------+

Annotations
@SerialVersionUID()
trait BSONReader[B <: BSONValue, T] extends AnyRef

A reader that produces an instance of T from a subtype of BSONValue.
case class BSONRegex(value: String, flags: String) extends BSONValue with Product with Serializable

BSON Regex value.
BSON Regex value.
flags
Regex flags.
case class BSONString(value: String) extends BSONValue with Product with Serializable
case class BSONSymbol(value: String) extends BSONValue with Product with Serializable

BSON Symbol value.
case class BSONTimestamp(value: Long) extends BSONValue with Product with Serializable

BSON Timestamp value
sealed trait BSONValue extends AnyRef
trait BSONWriter[T, B <: BSONValue] extends AnyRef

A writer that produces a subtype of BSONValue fron an instance of T.
trait DefaultBSONHandlers extends AnyRef
sealed trait ElementProducer extends Producer[BSONElement]
abstract class IdentityBSONConverter[T <: BSONValue] extends BSONReader[T, T] with BSONWriter[T, T]

Definition Classes
DefaultBSONHandlers
sealed trait Producer[T] extends AnyRef
sealed trait Subtype extends AnyRef

Binary Subtype
sealed trait UnsafeBSONReader[T] extends AnyRef
trait VariantBSONDocumentReader[+T] extends VariantBSONReader[BSONDocument, T]
trait VariantBSONDocumentWriter[-T] extends VariantBSONWriter[T, BSONDocument]
trait VariantBSONReader[-B <: BSONValue, +T] extends AnyRef

A reader that produces an instance of T from a subtype of BSONValue.
class VariantBSONReaderWrapper[B <: BSONValue, T] extends BSONReader[B, T]
trait VariantBSONWriter[-T, +B <: BSONValue] extends AnyRef

A writer that produces a subtype of BSONValue fron an instance of T.
class VariantBSONWriterWrapper[T, B <: BSONValue] extends BSONWriter[T, B]

Value Members

object BSON
object BSONArray extends Serializable
implicit object BSONArrayIdentity extends IdentityBSONConverter[BSONArray]

Definition Classes
DefaultBSONHandlers
object BSONBinary extends Serializable
implicit object BSONBinaryHandler extends BSONHandler[BSONBinary, Array[Byte]]

Definition Classes
DefaultBSONHandlers
implicit object BSONBinaryIdentity extends IdentityBSONConverter[BSONBinary]

Definition Classes
DefaultBSONHandlers
implicit object BSONBooleanHandler extends BSONHandler[BSONBoolean, Boolean]

Definition Classes
DefaultBSONHandlers
implicit object BSONBooleanIdentity extends IdentityBSONConverter[BSONBoolean]

Definition Classes
DefaultBSONHandlers
object BSONBooleanLike
implicit object BSONBooleanLikeWriter extends VariantBSONWriter[BSONBooleanLike, BSONValue]

Definition Classes
DefaultBSONHandlers
object BSONDBPointer extends AbstractFunction2[String, Array[Byte], BSONDBPointer] with Serializable
implicit object BSONDateTimeHandler extends BSONHandler[BSONDateTime, Date]

Definition Classes
DefaultBSONHandlers
implicit object BSONDateTimeIdentity extends IdentityBSONConverter[BSONDateTime]

Definition Classes
DefaultBSONHandlers
object BSONDocument extends Serializable
def BSONDocumentHandler[T](read: (BSONDocument) ⇒ T, write: (T) ⇒ BSONDocument): BSONDocumentHandler[T]

Handler factory
implicit object BSONDocumentIdentity extends IdentityBSONConverter[BSONDocument] with BSONDocumentReader[BSONDocument] with BSONDocumentWriter[BSONDocument]

Definition Classes
DefaultBSONHandlers
object BSONDocumentReader
object BSONDocumentWriter
implicit object BSONDoubleHandler extends BSONHandler[BSONDouble, Double]

Definition Classes
DefaultBSONHandlers
implicit object BSONDoubleIdentity extends IdentityBSONConverter[BSONDouble]

Definition Classes
DefaultBSONHandlers
object BSONElement extends BSONElementLowPriority with Serializable
object BSONElementSet
object BSONHandler
implicit object BSONIntegerHandler extends BSONHandler[BSONInteger, Int]

Definition Classes
DefaultBSONHandlers
implicit object BSONIntegerIdentity extends IdentityBSONConverter[BSONInteger]

Definition Classes
DefaultBSONHandlers
implicit object BSONJavaScriptIdentity extends BSONReader[BSONJavaScript, BSONJavaScript] with BSONWriter[BSONJavaScript, BSONJavaScript]

Definition Classes
DefaultBSONHandlers
implicit object BSONLongHandler extends BSONHandler[BSONLong, Long]

Definition Classes
DefaultBSONHandlers
implicit object BSONLongIdentity extends IdentityBSONConverter[BSONLong]

Definition Classes
DefaultBSONHandlers
object BSONMaxKey extends BSONValue

BSON Max key value
object BSONMinKey extends BSONValue

BSON Min key value
object BSONNull extends BSONValue with Product with Serializable

BSON null value
implicit object BSONNullIdentity extends IdentityBSONConverter[BSONNull.type]

Definition Classes
DefaultBSONHandlers
object BSONNumberLike
implicit object BSONNumberLikeWriter extends VariantBSONWriter[BSONNumberLike, BSONValue]

Definition Classes
DefaultBSONHandlers
object BSONObjectID extends Serializable
implicit object BSONObjectIDIdentity extends IdentityBSONConverter[BSONObjectID]

Definition Classes
DefaultBSONHandlers
object BSONReader
implicit object BSONRegexIdentity extends IdentityBSONConverter[BSONRegex]

Definition Classes
DefaultBSONHandlers
implicit object BSONStringHandler extends BSONHandler[BSONString, String]

Definition Classes
DefaultBSONHandlers
implicit object BSONStringIdentity extends IdentityBSONConverter[BSONString]

Definition Classes
DefaultBSONHandlers
object BSONTimestamp extends Serializable

Timestamp companion
object BSONUndefined extends BSONValue with Product with Serializable

BSON Undefined value
implicit object BSONUndefinedIdentity extends IdentityBSONConverter[BSONUndefined.type]

Definition Classes
DefaultBSONHandlers
object BSONValue
implicit object BSONValueIdentity extends IdentityBSONConverter[BSONValue]

Definition Classes
DefaultBSONHandlers
object BSONWriter
object DefaultBSONHandlers extends DefaultBSONHandlers
object ElementProducer
object Macros

Macros for generating BSONReader and BSONWriter implementations for case at compile time.
Macros for generating BSONReader and BSONWriter implementations for case at compile time. Invoking these macros is equivalent to writing anonymous class implementations by hand.
```
case class Person(name: String, surname: String)
implicit val personHandler = Macros.handler[Person]
```
See also
Macros.Options for specific options
implicit def MapReader[K, V](implicit keyReader: BSONReader[BSONString, K], valueReader: BSONReader[_ <: BSONValue, V]): BSONDocumentReader[Map[K, V]]

Definition Classes
DefaultBSONHandlers
implicit def MapWriter[K, V](implicit keyWriter: BSONWriter[K, BSONString], valueWriter: BSONWriter[V, _ <: BSONValue]): BSONDocumentWriter[Map[K, V]]

Definition Classes
DefaultBSONHandlers
object Producer
object Subtype
def array(values: Producer[BSONValue]*): BSONArray

Returns an array with given values.
def array: BSONArray

Returns an empty array.
implicit def bsonArrayToCollectionReader[M[_], T](implicit cbf: CanBuildFrom[M[_], T, M[T]], reader: BSONReader[_ <: BSONValue, T]): BSONReader[BSONArray, M[T]]

Definition Classes
DefaultBSONHandlers
implicit def bsonBooleanLikeReader[B <: BSONValue]: BSONBooleanLikeReader[B]

Definition Classes
DefaultBSONHandlers
implicit def bsonNumberLikeReader[B <: BSONValue]: BSONNumberLikeReader[B]

Definition Classes
DefaultBSONHandlers
package buffer
implicit def collectionToBSONArrayCollectionWriter[T, Repr](implicit arg0: (Repr) ⇒ Traversable[T], writer: BSONWriter[T, _ <: BSONValue]): VariantBSONWriter[Repr, BSONArray]

Definition Classes
DefaultBSONHandlers
def document(elements: Producer[BSONElement]*): BSONDocument

Returns a document with given elements.
def document: BSONDocument

Returns an empty document.
def element(name: String, value: BSONValue): BSONElement
package exceptions
implicit def findReader[T](implicit reader: VariantBSONReader[_ <: BSONValue, T]): BSONReader[_ <: BSONValue, T]

Definition Classes
DefaultBSONHandlers
implicit def findWriter[T](implicit writer: VariantBSONWriter[T, _ <: BSONValue]): BSONWriter[T, _ <: BSONValue]

Definition Classes
DefaultBSONHandlers
def generateId: BSONObjectID

Returns a newly generated object ID.
package lowlevel
package utils

package bson

Type Members

case class BSONArray(stream: Stream[Try[BSONValue]]) extends BSONValue with BSONElementSet with Product with Serializable

class BSONArrayCollectionReader[M[_], T] extends BSONReader[BSONArray, M[T]]

class BSONArrayCollectionWriter[T, Repr] extends VariantBSONWriter[Repr, BSONArray]

case class BSONBinary(value: ReadableBuffer, subtype: Subtype) extends BSONValue with Product with Serializable

case class BSONBoolean(value: Boolean) extends BSONValue with Product with Serializable

sealed trait BSONBooleanLike extends AnyRef

sealed trait BSONBooleanLikeClass[B <: BSONValue] extends BSONBooleanLike

class BSONBooleanLikeReader[B <: BSONValue] extends BSONReader[B, BSONBooleanLike]

class BSONDBPointer extends BSONValue with Product with Serializable with Serializable

case class BSONDateTime(value: Long) extends BSONValue with Product with Serializable

case class BSONDocument(stream: Stream[Try[BSONElement]]) extends BSONValue with BSONElementSet with Product with Serializable

type BSONDocumentHandler[T] = BSONDocumentReader[T] with BSONDocumentWriter[T] with BSONHandler[BSONDocument, T]

trait BSONDocumentReader[T] extends BSONReader[BSONDocument, T]

trait BSONDocumentWriter[T] extends BSONWriter[T, BSONDocument]

case class BSONDouble(value: Double) extends BSONValue with Product with Serializable

case class BSONElement(name: String, value: BSONValue) extends ElementProducer with Product with Serializable

sealed trait BSONElementLowPriority extends AnyRef

sealed trait BSONElementSet extends ElementProducer

trait BSONHandler[B <: BSONValue, T] extends BSONReader[B, T] with BSONWriter[T, B]

case class BSONInteger(value: Int) extends BSONValue with Product with Serializable

case class BSONJavaScript(value: String) extends BSONValue with Product with Serializable

case class BSONJavaScriptWS(value: String) extends BSONValue with Product with Serializable

case class BSONLong(value: Long) extends BSONValue with Product with Serializable

sealed trait BSONNumberLike extends AnyRef

sealed trait BSONNumberLikeClass[B <: BSONValue] extends BSONNumberLike

class BSONNumberLikeReader[B <: BSONValue] extends BSONReader[B, BSONNumberLike]

class BSONObjectID extends BSONValue with Serializable with Equals

trait BSONReader[B <: BSONValue, T] extends AnyRef

case class BSONRegex(value: String, flags: String) extends BSONValue with Product with Serializable

case class BSONString(value: String) extends BSONValue with Product with Serializable

case class BSONSymbol(value: String) extends BSONValue with Product with Serializable

case class BSONTimestamp(value: Long) extends BSONValue with Product with Serializable

sealed trait BSONValue extends AnyRef

trait BSONWriter[T, B <: BSONValue] extends AnyRef

trait DefaultBSONHandlers extends AnyRef

sealed trait ElementProducer extends Producer[BSONElement]

abstract class IdentityBSONConverter[T <: BSONValue] extends BSONReader[T, T] with BSONWriter[T, T]

sealed trait Producer[T] extends AnyRef

sealed trait Subtype extends AnyRef

sealed trait UnsafeBSONReader[T] extends AnyRef

trait VariantBSONDocumentReader[+T] extends VariantBSONReader[BSONDocument, T]

trait VariantBSONDocumentWriter[-T] extends VariantBSONWriter[T, BSONDocument]

trait VariantBSONReader[-B <: BSONValue, +T] extends AnyRef

class VariantBSONReaderWrapper[B <: BSONValue, T] extends BSONReader[B, T]

trait VariantBSONWriter[-T, +B <: BSONValue] extends AnyRef

class VariantBSONWriterWrapper[T, B <: BSONValue] extends BSONWriter[T, B]

Value Members

object BSON

object BSONArray extends Serializable

implicit object BSONArrayIdentity extends IdentityBSONConverter[BSONArray]

object BSONBinary extends Serializable

implicit object BSONBinaryHandler extends BSONHandler[BSONBinary, Array[Byte]]

implicit object BSONBinaryIdentity extends IdentityBSONConverter[BSONBinary]

implicit object BSONBooleanHandler extends BSONHandler[BSONBoolean, Boolean]

implicit object BSONBooleanIdentity extends IdentityBSONConverter[BSONBoolean]

object BSONBooleanLike

implicit object BSONBooleanLikeWriter extends VariantBSONWriter[BSONBooleanLike, BSONValue]

object BSONDBPointer extends AbstractFunction2[String, Array[Byte], BSONDBPointer] with Serializable

implicit object BSONDateTimeHandler extends BSONHandler[BSONDateTime, Date]

implicit object BSONDateTimeIdentity extends IdentityBSONConverter[BSONDateTime]

object BSONDocument extends Serializable

def BSONDocumentHandler[T](read: (BSONDocument) ⇒ T, write: (T) ⇒ BSONDocument): BSONDocumentHandler[T]

implicit object BSONDocumentIdentity extends IdentityBSONConverter[BSONDocument] with BSONDocumentReader[BSONDocument] with BSONDocumentWriter[BSONDocument]

object BSONDocumentReader

object BSONDocumentWriter

implicit object BSONDoubleHandler extends BSONHandler[BSONDouble, Double]

implicit object BSONDoubleIdentity extends IdentityBSONConverter[BSONDouble]

object BSONElement extends BSONElementLowPriority with Serializable

object BSONElementSet

object BSONHandler

implicit object BSONIntegerHandler extends BSONHandler[BSONInteger, Int]

implicit object BSONIntegerIdentity extends IdentityBSONConverter[BSONInteger]

implicit object BSONJavaScriptIdentity extends BSONReader[BSONJavaScript, BSONJavaScript] with BSONWriter[BSONJavaScript, BSONJavaScript]

implicit object BSONLongHandler extends BSONHandler[BSONLong, Long]

implicit object BSONLongIdentity extends IdentityBSONConverter[BSONLong]

object BSONMaxKey extends BSONValue

object BSONMinKey extends BSONValue