Packages

trait BSONDocumentWriter[T] extends BSONWriter[T]

BSONWriter specialized for BSONDocument

Self Type
BSONDocumentWriter[T]
Linear Supertypes
BSONWriter[T], AnyRef, Any
Known Subclasses
BSONDocumentHandler, Handler
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONDocumentWriter
  2. BSONWriter
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def writeTry(t: T): Try[BSONDocument]

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

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

    import scala.util.Try
import reactivemongo.api.bson.{ BSONWriter, BSONValue }

def toBSON[T](value: T)(implicit w: BSONWriter[T]): Try[BSONValue] =
  w.writeTry(value)
    Definition Classes
    BSONDocumentWriter → BSONWriter

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toany2stringadd[BSONDocumentWriter[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONDocumentWriter[T], B)
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toArrowAssoc[BSONDocumentWriter[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def afterWrite(f: (BSONDocument) => BSONDocument): BSONDocumentWriter[T]
  7. def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONWriter[T]

    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
    BSONWriter
  8. def afterWriteTry(f: (BSONDocument) => Try[BSONDocument]): BSONDocumentWriter[T]
  9. def afterWriteTry(f: (BSONValue) => Try[BSONValue]): BSONWriter[T]

    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.

    f

    the safe function to apply

    Definition Classes
    BSONWriter
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. final def beforeWrite[U](f: (U) => T): BSONDocumentWriter[U]

    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

    import reactivemongo.api.bson.BSONWriter

val w: BSONWriter[String] =
  implicitly[BSONWriter[Int]].beforeWrite(_.size)

w.writeTry("foo") // Success: BSONInteger(3)
    Definition Classes
    BSONDocumentWriter → BSONWriter
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. def ensuring(cond: (BSONDocumentWriter[T]) => Boolean, msg: => Any): BSONDocumentWriter[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toEnsuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (BSONDocumentWriter[T]) => Boolean): BSONDocumentWriter[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toEnsuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): BSONDocumentWriter[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toEnsuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): BSONDocumentWriter[T]
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toEnsuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def narrow[U <: T]: BSONDocumentWriter[U]

    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
    BSONDocumentWriter → BSONWriter
    Annotations
    @SuppressWarnings()
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. def writeOpt(t: T): Option[BSONDocument]

    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.

    import reactivemongo.api.bson.{ BSONWriter, BSONValue }

def maybeBSON[T](value: T)(implicit w: BSONWriter[T]): Option[BSONValue] =
  w.writeOpt(value)
    Definition Classes
    BSONDocumentWriter → BSONWriter

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toStringFormat[BSONDocumentWriter[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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (BSONDocumentWriter[T], B)
    Implicit
    This member is added by an implicit conversion from BSONDocumentWriter[T] toArrowAssoc[BSONDocumentWriter[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.

Inherited from BSONWriter[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBSONDocumentWriter[T] to any2stringadd[BSONDocumentWriter[T]]

Inherited by implicit conversion StringFormat fromBSONDocumentWriter[T] to StringFormat[BSONDocumentWriter[T]]

Inherited by implicit conversion Ensuring fromBSONDocumentWriter[T] to Ensuring[BSONDocumentWriter[T]]

Inherited by implicit conversion ArrowAssoc fromBSONDocumentWriter[T] to ArrowAssoc[BSONDocumentWriter[T]]

Ungrouped