Packages

trait BSONDocumentHandler[T] extends BSONDocumentReader[T] with BSONDocumentWriter[T] with BSONHandler[T]

Reads and writers T values to/from BSONDocument.

Linear Supertypes
BSONHandler[T], BSONDocumentWriter[T], BSONWriter[T], BSONDocumentReader[T], BSONReader[T], AnyRef, Any
Known Subclasses
Handler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONDocumentHandler
  2. BSONHandler
  3. BSONDocumentWriter
  4. BSONWriter
  5. BSONDocumentReader
  6. BSONReader
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def readDocument(doc: BSONDocument): Try[T]

    Tries to produce an instance of T from the document.

    Tries to produce an instance of T from the document.

    import scala.util.Try
import reactivemongo.api.bson.{ BSONDocument, BSONDocumentReader }

def fromBSON[T](document: BSONDocument)(
  implicit r: BSONDocumentReader[T]): Try[T] = r.readTry(document)
    Definition Classes
    BSONDocumentReader
  2. abstract def writeTry(t: T): Try[BSONDocument]

    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
    BSONDocumentWriter → 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 BSONDocumentHandler[T] to any2stringadd[BSONDocumentHandler[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONDocumentHandler[T], B)
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to ArrowAssoc[BSONDocumentHandler[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def afterRead[U](f: (T) ⇒ U): BSONDocumentReader[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
    BSONDocumentReader → BSONReader
  7. final def afterWrite(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentHandler[T]
    Definition Classes
    BSONDocumentHandler → BSONDocumentWriter
  8. 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
    BSONHandler → BSONWriter
  9. final def afterWriteTry(f: (BSONDocument) ⇒ Try[BSONDocument]): BSONDocumentHandler[T]
    Definition Classes
    BSONDocumentHandler → BSONDocumentWriter
  10. 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.

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

    f

    the safe function to apply

    Definition Classes
    BSONHandler → BSONWriter
  11. final def as[R](to: (T) ⇒ R, from: (R) ⇒ T): BSONHandler[R]
    Definition Classes
    BSONHandler
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. final def beforeRead(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentHandler[T]
    Definition Classes
    BSONDocumentHandler → BSONDocumentReader
  14. 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
    BSONHandler → BSONReader
  15. final def beforeReadTry(f: (BSONDocument) ⇒ Try[BSONDocument]): BSONDocumentHandler[T]
    Definition Classes
    BSONDocumentHandler → BSONDocumentReader
  16. 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.

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

    Definition Classes
    BSONHandler → BSONReader
  17. final def beforeWrite[U](f: (U) ⇒ T): BSONDocumentWriter[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
    BSONDocumentWriter → BSONWriter
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  19. def ensuring(cond: (BSONDocumentHandler[T]) ⇒ Boolean, msg: ⇒ Any): BSONDocumentHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to Ensuring[BSONDocumentHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (BSONDocumentHandler[T]) ⇒ Boolean): BSONDocumentHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to Ensuring[BSONDocumentHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocumentHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to Ensuring[BSONDocumentHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean): BSONDocumentHandler[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to Ensuring[BSONDocumentHandler[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to StringFormat[BSONDocumentHandler[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. final def narrow[U <: T]: BSONDocumentHandler[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
    BSONDocumentHandler → BSONHandler → BSONDocumentWriter → BSONWriter
    Annotations
    @SuppressWarnings()
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. 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
  35. 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
  36. final 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
    BSONDocumentReader → BSONReader
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  42. final def widen[U >: T]: BSONDocumentHandler[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
    BSONDocumentHandler → BSONHandler → BSONDocumentReader → BSONReader
    Annotations
    @SuppressWarnings()
  43. def writeOpt(t: T): Option[BSONDocument]

    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
    BSONDocumentWriter → BSONWriter
  44. def →[B](y: B): (BSONDocumentHandler[T], B)
    Implicit
    This member is added by an implicit conversion from BSONDocumentHandler[T] to ArrowAssoc[BSONDocumentHandler[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from BSONHandler[T]

Inherited from BSONDocumentWriter[T]

Inherited from BSONWriter[T]

Inherited from BSONDocumentReader[T]

Inherited from BSONReader[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BSONDocumentHandler[T] to any2stringadd[BSONDocumentHandler[T]]

Inherited by implicit conversion StringFormat from BSONDocumentHandler[T] to StringFormat[BSONDocumentHandler[T]]

Inherited by implicit conversion Ensuring from BSONDocumentHandler[T] to Ensuring[BSONDocumentHandler[T]]

Inherited by implicit conversion ArrowAssoc from BSONDocumentHandler[T] to ArrowAssoc[BSONDocumentHandler[T]]

Ungrouped