trait BSONHandler[T] extends BSONReader[T] with BSONWriter[T]
A BSON handler is able to both read and write T
values
from/to BSON representation.
import scala.util.Try import reactivemongo.api.bson.{ BSONHandler, BSONValue } def roundtrip[T](value: T)(implicit handler: BSONHandler[T]): Try[Boolean] = for { bson: BSONValue <- handler.writeTry(value) dser <- handler.readTry(bson) } yield (dser == value) // true
- Alphabetic
- By Inheritance
- BSONHandler
- BSONWriter
- BSONReader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
readTry(bson: BSONValue): Try[T]
Tries to produce an instance of
T
from thebson
value.Tries to produce an instance of
T
from thebson
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
- BSONReader
-
abstract
def
writeTry(t: T): Try[BSONValue]
Tries to produce a BSON value from an instance of
T
.Tries to produce a BSON value from an instance of
T
.- Definition Classes
- BSONWriter
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to any2stringadd[BSONHandler[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BSONHandler[T], B)
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to ArrowAssoc[BSONHandler[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
afterRead[U](f: (T) ⇒ 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
-
final
def
afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONWriter[T]
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 aFailure
.- f
the partial function to apply
- Definition Classes
- BSONWriter
- final def as[R](to: (T) ⇒ R, from: (R) ⇒ T): BSONHandler[R]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONReader[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.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
-
def
beforeWrite[U](f: (U) ⇒ T): 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 atT
value used to the current writer
- Definition Classes
- BSONWriter
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (BSONHandler[T]) ⇒ Boolean, msg: ⇒ Any): BSONHandler[T]
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to Ensuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BSONHandler[T]) ⇒ Boolean): BSONHandler[T]
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to Ensuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BSONHandler[T]
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to Ensuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BSONHandler[T]
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to Ensuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to StringFormat[BSONHandler[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- 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()
-
def
readOpt(bson: BSONValue): Option[T]
Tries to produce an instance of
T
from thebson
value, returnsNone
if an error occurred.Tries to produce an instance of
T
from thebson
value, returnsNone
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
- BSONReader
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
widen[U >: T]: 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
-
def
writeOpt(t: T): Option[BSONValue]
Tries to produce a BSON value from an instance of
T
, returnsNone
if an error occurred.Tries to produce a BSON value from an instance of
T
, returnsNone
if an error occurred.- Definition Classes
- BSONWriter
-
def
→[B](y: B): (BSONHandler[T], B)
- Implicit
- This member is added by an implicit conversion from BSONHandler[T] to ArrowAssoc[BSONHandler[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc