BSONDocumentWriter

Abstract Value Members

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

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to any2stringadd[BSONDocumentWriter[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (BSONDocumentWriter[T], B)

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to ArrowAssoc[BSONDocumentWriter[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def afterWrite(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentWriter[T]
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
def afterWriteTry(f: (BSONDocument) ⇒ Try[BSONDocument]): BSONDocumentWriter[T]
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
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
def clone(): AnyRef

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

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to Ensuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (BSONDocumentWriter[T]) ⇒ Boolean): BSONDocumentWriter[T]

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to Ensuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocumentWriter[T]

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to Ensuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): BSONDocumentWriter[T]

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to Ensuring[BSONDocumentWriter[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to StringFormat[BSONDocumentWriter[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any

def narrow[U <: T]: BSONDocumentWriter[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()

final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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
def →[B](y: B): (BSONDocumentWriter[T], B)

Implicit information
This member is added by an implicit conversion from BSONDocumentWriter[T] to ArrowAssoc[BSONDocumentWriter[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object BSONDocumentWriter | package bson

trait BSONDocumentWriter[T] extends BSONWriter[T]

Abstract Value Members

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (BSONDocumentWriter[T], B)

final def ==(arg0: Any): Boolean

def afterWrite(f: (BSONDocument) ⇒ BSONDocument): BSONDocumentWriter[T]

def afterWrite(f: PartialFunction[BSONValue, BSONValue]): BSONWriter[T]

def afterWriteTry(f: (BSONDocument) ⇒ Try[BSONDocument]): BSONDocumentWriter[T]

def afterWriteTry(f: (BSONValue) ⇒ Try[BSONValue]): BSONWriter[T]

final def asInstanceOf[T0]: T0

final def beforeWrite[U](f: (U) ⇒ T): BSONDocumentWriter[U]

def clone(): AnyRef

def ensuring(cond: (BSONDocumentWriter[T]) ⇒ Boolean, msg: ⇒ Any): BSONDocumentWriter[T]

def ensuring(cond: (BSONDocumentWriter[T]) ⇒ Boolean): BSONDocumentWriter[T]

def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocumentWriter[T]

def ensuring(cond: Boolean): BSONDocumentWriter[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def narrow[U <: T]: BSONDocumentWriter[U]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def writeOpt(t: T): Option[BSONDocument]

def →[B](y: B): (BSONDocumentWriter[T], B)

Inherited from BSONWriter[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped