BSONReader

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def apply[T](read: (BSONValue) ⇒ T): BSONReader[T]

   

   Creates a BSONReader based on the given read function.

   Creates a BSONReader based on the given read function.

   import reactivemongo.api.bson.{ BSONReader, BSONInteger }
   
   val intToStrCodeReader = BSONReader[String] {
     case BSONInteger(0) => "zero"
     case BSONInteger(1) => "one"
     case _ => "unknown"
   }
   
   intToStrCodeReader.readTry(BSONInteger(0)) // Success("zero")
   intToStrCodeReader.readTry(BSONInteger(1)) // Success("one")
   intToStrCodeReader.readTry(BSONInteger(2)) // Success("unknown")

   Any Exception thrown by the read function will be caught.

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. def collect[T](read: PartialFunction[BSONValue, T]): BSONReader[T]

   

   Creates a BSONReader based on the given partial function.

   Creates a BSONReader based on the given partial function.

   A exceptions.ValueDoesNotMatchException is returned as Failure for any BSON value that is not matched by the read function.

   import reactivemongo.api.bson.{ BSONReader, BSONInteger }
   
   val intToStrCodeReader = BSONReader.collect[String] {
     case BSONInteger(0) => "zero"
     case BSONInteger(1) => "one"
   }
   
   intToStrCodeReader.readTry(BSONInteger(0)) // Success("zero")
   intToStrCodeReader.readTry(BSONInteger(1)) // Success("one")
   
   intToStrCodeReader.readTry(BSONInteger(2))
   // => Failure(ValueDoesNotMatchException(..))
   
   intToStrCodeReader.readOpt(BSONInteger(3)) // None (as failed)

8. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

9. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

10. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

11. def from[T](read: (BSONValue) ⇒ Try[T]): BSONReader[T]

    

    Creates a BSONReader based on the given read function.

    Creates a BSONReader based on the given read function.

    import scala.util.{ Failure, Success }
    import reactivemongo.api.bson.{ BSONReader, BSONInteger }
    
    val intToStrCodeReader = BSONReader.from[String] {
      case BSONInteger(0) => Success("zero")
      case BSONInteger(1) => Success("one")
      case _ => Failure(new IllegalArgumentException())
    }
    
    intToStrCodeReader.readTry(BSONInteger(0)) // Success("zero")
    intToStrCodeReader.readTry(BSONInteger(1)) // Success("one")
    
    intToStrCodeReader.readTry(BSONInteger(2))
    // => Failure(IllegalArgumentException(..))
    
    intToStrCodeReader.readOpt(BSONInteger(3)) // None (as failed)

    read

    the safe function to read BSON values as T

12. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

13. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

14. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

15. def iterable[T, M[_]](read: (BSONValue) ⇒ Try[T])(implicit cbf: CanBuildFrom[M[_], T, M[T]]): BSONReader[M[T]]

    

    EXPERIMENTAL: (API may change without notice)

    EXPERIMENTAL: (API may change without notice)

    Creates a BSONReader accepting only BSONArray, and applying the given safe read function to each element value.

    import reactivemongo.api.bson.{ BSONReader, Macros }
    
    case class Element(str: String, v: Int)
    
    val elementHandler = Macros.handler[Element]
    
    val setReader: BSONReader[Set[Element]] =
      BSONReader.iterable[Element, Set](elementHandler readTry _)

    Definition Classes

    BSONReaderCompat

16. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

17. final def notify(): Unit

    

    Definition Classes

    AnyRef

18. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

19. def option[T](read: (BSONValue) ⇒ Option[T]): BSONReader[T]

    

    Creates a BSONReader based on the given read function.

    Creates a BSONReader based on the given read function.

    import reactivemongo.api.bson.{ BSONReader, BSONInteger }
    
    val intToStrCodeReader = BSONReader.option[String] {
      case BSONInteger(0) => Some("zero")
      case BSONInteger(1) => Some("one")
      case _ => None
    }
    
    intToStrCodeReader.readTry(BSONInteger(0)) // Success("zero")
    intToStrCodeReader.readTry(BSONInteger(1)) // Success("one")
    
    intToStrCodeReader.readTry(BSONInteger(2))
    // => Failure(ValueDoesNotMatchException(..))
    
    intToStrCodeReader.readOpt(BSONInteger(3)) // None (as failed)

20. def sequence[T](read: (BSONValue) ⇒ Try[T]): BSONReader[Seq[T]]

    

    EXPERIMENTAL: (API may change without notice)

    EXPERIMENTAL: (API may change without notice)

    Creates a BSONReader accepting only BSONArray, and applying the given safe read function to each element value.

    import reactivemongo.api.bson.BSONReader
    
    def foo(elmReader: BSONReader[(String, Int)]): BSONReader[Seq[(String, Int)]] = BSONReader.sequence(elmReader.readTry _)

21. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

22. def toString(): String

    

    Definition Classes

    AnyRef → Any

23. def tuple2[A, B](implicit arg0: BSONReader[A], arg1: BSONReader[B]): BSONReader[(A, B)]

    

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    import reactivemongo.api.bson.{ BSONArray, BSONReader }
    
    val reader = BSONReader.tuple2[String, Int]
    
    val arr = BSONArray("Foo", 20)
    
    reader.readTry(arr) // => Success(("Foo", 20))

24. def tuple3[A, B, C](implicit arg0: BSONReader[A], arg1: BSONReader[B], arg2: BSONReader[C]): BSONReader[(A, B, C)]

    

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    See also

    tuple2

25. def tuple4[A, B, C, D](implicit arg0: BSONReader[A], arg1: BSONReader[B], arg2: BSONReader[C], arg3: BSONReader[D]): BSONReader[(A, B, C, D)]

    

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    See also

    tuple2

26. def tuple5[A, B, C, D, E](implicit arg0: BSONReader[A], arg1: BSONReader[B], arg2: BSONReader[C], arg3: BSONReader[D], arg4: BSONReader[E]): BSONReader[(A, B, C, D, E)]

    

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    EXPERIMENTAL: Creates a BSONDocumentReader that reads the BSONArray elements.

    See also

    tuple2

27. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

29. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )