trait BSONDocumentReader[T] extends BSONReader[T]
BSONReader specialized for BSONDocument
- Self Type
- BSONDocumentReader[T]
- Alphabetic
- By Inheritance
- BSONDocumentReader
- BSONReader
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def readDocument(doc: BSONDocument): Try[T]
Tries to produce an instance of
T
from thedocument
.Tries to produce an instance of
T
from thedocument
.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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- BSONDocumentReader → BSONReader
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def beforeRead(f: (BSONDocument) => BSONDocument): BSONDocumentReader[T]
- 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
- def beforeReadTry(f: (BSONDocument) => Try[BSONDocument]): BSONDocumentReader[T]
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def collect[U](read: PartialFunction[T, U]): BSONReader[U]
EXPERIMENTAL: (API may change without notice)
EXPERIMENTAL: (API may change without notice)
- Definition Classes
- BSONReader
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def readOpt(bson: BSONValue): Option[T]
Tries to produce an instance of
T
from thebson
value, returnsNone
if an error occurred.Tries to produce an instance of
T
from thebson
value, returnsNone
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
- def readOrElse(bson: BSONValue, default: => T): T
Tries to produce an instance of
T
from thebson
value, returns thedefault
value if an error occurred.Tries to produce an instance of
T
from thebson
value, returns thedefault
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
- final def readTry(bson: BSONValue): Try[T]
Tries to produce an instance of
T
from thebson
value.Tries to produce an instance of
T
from thebson
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
- BSONDocumentReader → BSONReader
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
- BSONDocumentReader → BSONReader
- Annotations
- @SuppressWarnings()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.