Trait/Object

reactivemongo.api.bson

BSONReader

Related Docs: object BSONReader | package bson

Permalink

trait BSONReader[T] extends AnyRef

A reader that produces an instance of T from a subtype of BSONValue.

Self Type
BSONReader[T]
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONReader
  2. AnyRef
  3. 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 readTry(bson: BSONValue): Try[T]

    Permalink

    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)

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to any2stringadd[BSONReader[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONReader[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to ArrowAssoc[BSONReader[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def afterRead[U](f: (T) ⇒ U): BSONReader[U]

    Permalink

    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

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONReader[T]

    Permalink

    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)
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (BSONReader[T]) ⇒ Boolean, msg: ⇒ Any): BSONReader[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to Ensuring[BSONReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (BSONReader[T]) ⇒ Boolean): BSONReader[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to Ensuring[BSONReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): BSONReader[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to Ensuring[BSONReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): BSONReader[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to Ensuring[BSONReader[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to StringFormat[BSONReader[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def readOpt(bson: BSONValue): Option[T]

    Permalink

    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)
  25. def readOrElse(bson: BSONValue, default: ⇒ T): T

    Permalink

    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)
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def widen[U >: T]: BSONReader[U]

    Permalink

    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

    Annotations
    @SuppressWarnings()
  32. def [B](y: B): (BSONReader[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from BSONReader[T] to ArrowAssoc[BSONReader[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped