Trait/Object

reactivemongo.api.bson

BSONDocumentHandler

Related Docs: object BSONDocumentHandler | package bson

Permalink

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

Reads and writers T values to/from BSONDocument.

Linear Supertypes
Known Subclasses
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]

    Permalink
    Definition Classes
    BSONDocumentReader
  2. abstract def writeTry(t: T): Try[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
    BSONDocumentWriterBSONWriter

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 BSONDocumentHandler[T] to any2stringadd[BSONDocumentHandler[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONDocumentHandler[T], B)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def afterRead[U](f: (T) ⇒ 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
  7. final def afterWrite(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentHandler[T]

    Permalink
  8. final def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[T]

    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
  9. final def as[R](to: (T) ⇒ R, from: (R) ⇒ T): BSONHandler[R]

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

    Permalink
    Definition Classes
    Any
  11. final def beforeRead(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentHandler[T]

    Permalink
  12. final def beforeRead(f: PartialFunction[BSONValue, BSONValue]): BSONHandler[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)
    Definition Classes
    BSONHandlerBSONReader
  13. final def beforeWrite[U](f: (U) ⇒ T): 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
  14. def clone(): AnyRef

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

    Permalink
    Implicit information
    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
  16. def ensuring(cond: (BSONDocumentHandler[T]) ⇒ Boolean): BSONDocumentHandler[T]

    Permalink
    Implicit information
    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
  17. def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocumentHandler[T]

    Permalink
    Implicit information
    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
  18. def ensuring(cond: Boolean): BSONDocumentHandler[T]

    Permalink
    Implicit information
    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
  19. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Implicit information
    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()
  23. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  26. final def narrow[U <: T]: BSONDocumentHandler[U]

    Permalink

    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
    BSONDocumentHandlerBSONHandlerBSONDocumentWriterBSONWriter
    Annotations
    @SuppressWarnings()
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. 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)
    Definition Classes
    BSONReader
  31. 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)
    Definition Classes
    BSONReader
  32. final 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)
    Definition Classes
    BSONDocumentReaderBSONReader
  33. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def widen[U >: T]: BSONDocumentHandler[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

    Definition Classes
    BSONDocumentHandlerBSONHandlerBSONDocumentReaderBSONReader
    Annotations
    @SuppressWarnings()
  39. def writeOpt(t: T): 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
  40. def [B](y: B): (BSONDocumentHandler[T], B)

    Permalink
    Implicit information
    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