Packages

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
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONHandler
  2. BSONWriter
  3. BSONReader
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

    Tries to produce an instance of T from the bson value.

    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)
    Definition Classes
    BSONReader
  2. 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.

    import scala.util.Try
    import reactivemongo.api.bson.{ BSONWriter, BSONValue }
    
    def toBSON[T](value: T)(implicit w: BSONWriter[T]): Try[BSONValue] =
      w.writeTry(value)
    Definition Classes
    BSONWriter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toany2stringadd[BSONHandler[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONHandler[T], B)
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toArrowAssoc[BSONHandler[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. 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.

    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 a Failure.

    f

    the partial function to apply

    Definition Classes
    BSONHandlerBSONWriter
  8. final def as[R](to: (T) => R, from: (R) => T): BSONHandler[R]
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. 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.

    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
    BSONHandlerBSONReader
  11. 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 at T value used to the current writer

    import reactivemongo.api.bson.BSONWriter
    
    val w: BSONWriter[String] =
      implicitly[BSONWriter[Int]].beforeWrite(_.size)
    
    w.writeTry("foo") // Success: BSONInteger(3)
    Definition Classes
    BSONWriter
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def ensuring(cond: (BSONHandler[T]) => Boolean, msg: => Any): BSONHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toEnsuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (BSONHandler[T]) => Boolean): BSONHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toEnsuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): BSONHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toEnsuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): BSONHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toEnsuring[BSONHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toStringFormat[BSONHandler[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def narrow[U <: T]: BSONHandler[U]

    Narrows this writer for a compatible type 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]
    U

    must be a sub-type of T

    Definition Classes
    BSONHandlerBSONWriter
    Annotations
    @SuppressWarnings()
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def readOpt(bson: BSONValue): Option[T]

    Tries to produce an instance of T from the bson value, returns None if an error occurred.

    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)
    Definition Classes
    BSONReader
  29. 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.

    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)
    Definition Classes
    BSONReader
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. def widen[U >: T]: BSONHandler[U]

    Widens this reader for a compatible type 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]
    U

    must be a super-type of T

    Definition Classes
    BSONHandlerBSONReader
    Annotations
    @SuppressWarnings()
  36. def writeOpt(t: T): Option[BSONValue]

    Tries to produce a BSON value from an instance of T, returns None if an error occurred.

    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)
    Definition Classes
    BSONWriter

Deprecated Value Members

  1. def [B](y: B): (BSONHandler[T], B)
    Implicit
    This member is added by an implicit conversion from BSONHandler[T] toArrowAssoc[BSONHandler[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from BSONWriter[T]

Inherited from BSONReader[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBSONHandler[T] to any2stringadd[BSONHandler[T]]

Inherited by implicit conversion StringFormat fromBSONHandler[T] to StringFormat[BSONHandler[T]]

Inherited by implicit conversion Ensuring fromBSONHandler[T] to Ensuring[BSONHandler[T]]

Inherited by implicit conversion ArrowAssoc fromBSONHandler[T] to ArrowAssoc[BSONHandler[T]]

Ungrouped