Packages

trait BSONDocumentReader[T] extends BSONReader[T]

BSONReader specialized for BSONDocument

Self Type
BSONDocumentReader[T]
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONDocumentReader
  2. BSONReader
  3. AnyRef
  4. 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 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)

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 BSONDocumentReader[T] toany2stringadd[BSONDocumentReader[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONDocumentReader[T], B)
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toArrowAssoc[BSONDocumentReader[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
    BSONDocumentReaderBSONReader
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def beforeRead(f: (BSONDocument) => BSONDocument): BSONDocumentReader[T]
  9. 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
  10. def beforeReadTry(f: (BSONDocument) => Try[BSONDocument]): BSONDocumentReader[T]
  11. def beforeReadTry(f: (BSONValue) => Try[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.

    Definition Classes
    BSONReader
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def collect[U](read: PartialFunction[T, U]): BSONReader[U]

    EXPERIMENTAL: (API may change without notice)

    EXPERIMENTAL: (API may change without notice)

    Definition Classes
    BSONReader
  14. def ensuring(cond: (BSONDocumentReader[T]) => Boolean, msg: => Any): BSONDocumentReader[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toEnsuring[BSONDocumentReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (BSONDocumentReader[T]) => Boolean): BSONDocumentReader[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toEnsuring[BSONDocumentReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): BSONDocumentReader[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toEnsuring[BSONDocumentReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): BSONDocumentReader[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toEnsuring[BSONDocumentReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. 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
  27. 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
  28. 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
    BSONDocumentReaderBSONReader
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. def widen[U >: T]: BSONDocumentReader[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
    BSONDocumentReaderBSONReader
    Annotations
    @SuppressWarnings()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toStringFormat[BSONDocumentReader[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (BSONDocumentReader[T], B)
    Implicit
    This member is added by an implicit conversion from BSONDocumentReader[T] toArrowAssoc[BSONDocumentReader[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 BSONReader[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBSONDocumentReader[T] to any2stringadd[BSONDocumentReader[T]]

Inherited by implicit conversion StringFormat fromBSONDocumentReader[T] to StringFormat[BSONDocumentReader[T]]

Inherited by implicit conversion Ensuring fromBSONDocumentReader[T] to Ensuring[BSONDocumentReader[T]]

Inherited by implicit conversion ArrowAssoc fromBSONDocumentReader[T] to ArrowAssoc[BSONDocumentReader[T]]

Ungrouped