Object

reactivemongo.api.bson.Macros.Placeholder

Handler

Related Doc: package Placeholder

Permalink

implicit object Handler extends BSONDocumentReader[Placeholder] with BSONDocumentWriter[Placeholder] with BSONHandler[Placeholder]

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Handler
  2. BSONHandler
  3. BSONDocumentWriter
  4. BSONWriter
  5. BSONDocumentReader
  6. BSONReader
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def afterRead[U](f: (Placeholder) ⇒ U): BSONDocumentReader[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

    Definition Classes
    BSONDocumentReaderBSONReader
  5. final def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[Placeholder]

    Permalink

    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
  6. def afterWrite(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentWriter[Placeholder]

    Permalink
    Definition Classes
    BSONDocumentWriter
  7. final def as[R](to: (Placeholder) ⇒ R, from: (R) ⇒ Placeholder): BSONHandler[R]

    Permalink
    Definition Classes
    BSONHandler
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. final def beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[Placeholder]

    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)
    Definition Classes
    BSONHandlerBSONReader
  10. def beforeRead(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentReader[Placeholder]

    Permalink
    Definition Classes
    BSONDocumentReader
  11. final def beforeWrite[U](f: (U) ⇒ Placeholder): BSONDocumentWriter[U]

    Permalink

    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

    Definition Classes
    BSONDocumentWriterBSONWriter
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  22. def readDocument(bson: BSONDocument): Success[Placeholder]

    Permalink
    Definition Classes
    HandlerBSONDocumentReader
  23. def readOpt(bson: BSONValue): Option[Placeholder]

    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)
    Definition Classes
    BSONReader
  24. def readOrElse(bson: BSONValue, default: ⇒ Placeholder): Placeholder

    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)
    Definition Classes
    BSONReader
  25. final def readTry(bson: BSONValue): Try[Placeholder]

    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)
    Definition Classes
    BSONDocumentReaderBSONReader
  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. final def widen[U >: Placeholder]: BSONDocumentReader[U]

    Permalink

    Widen this read for compatible type U.

    Widen this read for 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
  32. def writeOpt(t: Placeholder): Option[BSONDocument]

    Permalink

    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.

    Definition Classes
    BSONDocumentWriterBSONWriter
  33. def writeTry(pl: Placeholder): Success[BSONDocument]

    Permalink

    Tries to produce a BSON value from an instance of T.

    Tries to produce a BSON value from an instance of T.

    Definition Classes
    HandlerBSONDocumentWriterBSONWriter
    Annotations
    @silent()

Inherited from BSONHandler[Placeholder]

Inherited from BSONWriter[Placeholder]

Inherited from BSONReader[Placeholder]

Inherited from AnyRef

Inherited from Any

Ungrouped