reactivemongo-bson-api/reactivemongo.api.bson/BSONDocumentHandler

BSONDocumentHandler

object BSONDocumentHandler

BSONDocumentHandler factories

Companion:
class
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[T](read: BSONDocument => T, write: T => BSONDocument): BSONDocumentHandler[T]

Document handler factory.

Document handler factory.

import reactivemongo.api.bson.{ BSONDocument, BSONDocumentHandler }

case class Bar(score: Double)

val h: BSONDocumentHandler[Bar] = BSONDocumentHandler[Bar](
 read = { doc =>
   Bar(doc.getOrElse[Double]("score", 0D))
 },
 write = { bar => BSONDocument("score" -> bar.score) })
def collect[T](read: PartialFunction[BSONValue, T], write: PartialFunction[T, BSONDocument]): BSONDocumentHandler[T]

'''EXPERIMENTAL:''' Creates a BSONDocumentHandler based on the given read and write functions.

'''EXPERIMENTAL:''' Creates a BSONDocumentHandler based on the given read and write functions.

import reactivemongo.api.bson.{ BSONDocumentHandler, BSONDocument }

val handler = BSONDocumentHandler.collect[String](
 read = {
   case doc: BSONDocument => doc.getAsOpt[Int]("value").collect {
     case 0 => "zero"
     case 1 => "one"
   } getOrElse ""
 },
 write = {
   case "zero" => BSONDocument("value" -> 0)
   case "one" => BSONDocument("value" -> 1)
 })

handler.readTry(BSONDocument("value" -> 0)) // Success("zero")
handler.readOpt(BSONDocument("value" -> 3)) // None (as failed)

handler.writeTry("one") // Success(BSONDocument("value" -> 1))
handler.writeOpt("3") // None (as failed)
def from[T](read: BSONDocument => Try[T], write: T => Try[BSONDocument]): BSONDocumentHandler[T]

Creates a BSONDocumentHandler based on the given safe read and write functions.

Creates a BSONDocumentHandler based on the given safe read and write functions.

import scala.util.Success
import reactivemongo.api.bson.{ BSONDocument, BSONDocumentHandler }

case class Bar(score: Double)

val h: BSONDocumentHandler[Bar] = BSONDocumentHandler.from[Bar](
 read = _.getAsTry[Double]("score").map(Bar(_)),
 write = { bar => Success(BSONDocument("score" -> bar.score)) })
def option[T](read: BSONValue => Option[T], write: T => Option[BSONDocument]): BSONDocumentHandler[T]

Creates a BSONDocumentHandler based on the given read and write functions.

Creates a BSONDocumentHandler based on the given read and write functions.

import reactivemongo.api.bson.{ BSONDocumentHandler, BSONDocument }

val handler = BSONDocumentHandler.option[String](
 read = {
   case doc: BSONDocument => doc.getAsOpt[Int]("value").collect {
     case 0 => "zero"
     case 1 => "one"
   }
   case _ => None
 },
 write = {
   case "zero" => Some(BSONDocument("value" -> 0))
   case "one" => Some(BSONDocument("value" -> 1))
   case _ => None
 })

handler.readTry(BSONDocument("value" -> 0)) // Success("zero")
handler.readOpt(BSONDocument("value" -> 3)) // None (as failed)

handler.writeTry("one") // Success(BSONDocument("value" -> 1))
handler.writeOpt("3") // None (as failed)
def provided[T](implicit reader: BSONDocumentReader[T], writer: BSONDocumentWriter[T]): BSONDocumentHandler[T]

Returns a document handler for a type T, provided there are a writer and a reader for it.

Returns a document handler for a type T, provided there are a writer and a reader for it.

import reactivemongo.api.bson.{
 BSONDocumentHandler, BSONDocumentReader, BSONDocumentWriter
}

def foo[T](
 implicit r: BSONDocumentReader[T],
   w: BSONDocumentWriter[T]): BSONDocumentHandler[T] =
 BSONDocumentHandler.provided[T]