BSONHandler

abstract def readTry(bson: BSONValue): Try[T]

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)

abstract def writeTry(t: T): Try[BSONValue]

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)

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (BSONHandler[T], B)

final def ==(arg0: Any): Boolean

def afterRead[U](f: (T) ⇒ U): BSONReader[U]

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)
}

final def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[T]

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

final def afterWriteTry(f: (BSONValue) ⇒ Try[BSONValue]): BSONHandler[T]

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

final def as[R](to: (T) ⇒ R, from: (R) ⇒ T): BSONHandler[R]

final def asInstanceOf[T0]: T0

final def beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[T]

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)

final def beforeReadTry(f: (BSONValue) ⇒ Try[BSONValue]): BSONHandler[T]

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

def beforeWrite[U](f: (U) ⇒ T): BSONWriter[U]

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

def clone(): AnyRef

def ensuring(cond: (BSONHandler[T]) ⇒ Boolean, msg: ⇒ Any): BSONHandler[T]

def ensuring(cond: (BSONHandler[T]) ⇒ Boolean): BSONHandler[T]

def ensuring(cond: Boolean, msg: ⇒ Any): BSONHandler[T]

def ensuring(cond: Boolean): BSONHandler[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def narrow[U <: T]: BSONHandler[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]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def readOpt(bson: BSONValue): Option[T]

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)

def readOrElse(bson: BSONValue, default: ⇒ T): T

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)

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def widen[U >: T]: BSONHandler[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]

def writeOpt(t: T): Option[BSONValue]

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)

def →[B](y: B): (BSONHandler[T], B)