reactivemongo.bson

BSONDocument

case class BSONDocument(stream: Stream[Try[BSONElement]]) extends BSONValue with Product with Serializable

A BSONDocument structure (BSON type 0x03).

A BSONDocument is basically a stream of tuples (String, BSONValue). It is completely lazy. The stream it wraps is a Stream[Try[(String, BSONValue)]] since we cannot be sure that a not yet deserialized value will be processed without error.

Linear Supertypes
Serializable, Serializable, Product, Equals, BSONValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BSONDocument
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. BSONValue
  7. AnyRef
  8. Any
Implicitly
  1. by ExtendedBSONValue
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BSONDocument(stream: Stream[Try[BSONElement]])

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 information
    This member is added by an implicit conversion from BSONDocument to any2stringadd[BSONDocument] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ++(elements: Producer[(String, BSONValue)]*): BSONDocument

    Alias for add(elements: Producer[(String, BSONValue)]*): BSONDocument

  5. def ++(doc: BSONDocument): BSONDocument

    Alias for add(doc: BSONDocument): BSONDocument

  6. def ->[B](y: B): (BSONDocument, B)

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ArrowAssoc[BSONDocument] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  8. def add(elements: Producer[(String, BSONValue)]*): BSONDocument

    Creates a new BSONDocument containing all the elements of this one and the given elements.

  9. def add(doc: BSONDocument): BSONDocument

    Creates a new BSONDocument containing all the elements of this one and the elements of the given document.

  10. def as[T](implicit reader: BSONReader[BSONDocument, T]): T

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ExtendedBSONValue[BSONDocument] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. def asOpt[T](implicit reader: BSONReader[BSONDocument, T]): Option[T]

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ExtendedBSONValue[BSONDocument] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue

  13. def asTry[T](implicit reader: BSONReader[BSONDocument, T]): Try[T]

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ExtendedBSONValue[BSONDocument] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue

  14. val bson: BSONDocument

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ExtendedBSONValue[BSONDocument] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue

  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  16. val code: Byte

    Definition Classes
    BSONDocument → BSONValue

  17. def elements: Stream[BSONElement]

    Returns a Stream for all the elements of this BSONDocument.

  18. def ensuring(cond: (BSONDocument) ⇒ Boolean, msg: ⇒ Any): BSONDocument

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

  19. def ensuring(cond: (BSONDocument) ⇒ Boolean): BSONDocument

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

  20. def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocument

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

  21. def ensuring(cond: Boolean): BSONDocument

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

  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  24. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from BSONDocument to StringFormat[BSONDocument] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  25. def get(key: String): Option[BSONValue]

    Returns the BSONValue associated with the given key.

    Returns the BSONValue associated with the given key.

    If the key is not found or the matching value cannot be deserialized, returns None.

  26. def getAs[T](s: String)(implicit reader: BSONReader[_ <: BSONValue, T]): Option[T]

    Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.

    Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.

    If there is no matching value, or the value could not be deserialized or converted, returns a None.

  27. def getAsTry[T](s: String)(implicit reader: BSONReader[_ <: BSONValue, T]): Try[T]

    Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.

    Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.

    If there is no matching value, or the value could not be deserialized or converted, returns a Failure. The Failure holds a exceptions.DocumentKeyNotFound if the key could not be found.

  28. def getAsUnflattenedTry[T](s: String)(implicit reader: BSONReader[_ <: BSONValue, T]): Try[Option[T]]

    Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.

    Returns the BSONValue associated with the given key, and converts it with the given implicit BSONReader.

    If there is no matching value, returns a Success holding None. If the value could not be deserialized or converted, returns a Failure.

  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  30. def getTry(key: String): Try[BSONValue]

    Returns the BSONValue associated with the given key.

    Returns the BSONValue associated with the given key.

    If the key is not found or the matching value cannot be deserialized, returns a Failure. The Failure holds a exceptions.DocumentKeyNotFound if the key could not be found.

  31. def getUnflattenedTry(key: String): Try[Option[BSONValue]]

    Returns the BSONValue associated with the given key.

    Returns the BSONValue associated with the given key.

    If the key could not be found, the resulting option will be None. If the matching value could not be deserialized, returns a Failure.

  32. def isEmpty: Boolean

    Is this document empty?

  33. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  35. final def notify(): Unit

    Definition Classes
    AnyRef

  36. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  37. def seeAsOpt[T](implicit reader: BSONReader[_ <: BSONValue, T]): Option[T]

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ExtendedBSONValue[BSONDocument] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue

  38. def seeAsTry[T](implicit reader: BSONReader[_ <: BSONValue, T]): Try[T]

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ExtendedBSONValue[BSONDocument] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue

  39. val stream: Stream[Try[BSONElement]]

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

    Definition Classes
    AnyRef

  41. def toString(): String

    Definition Classes
    BSONDocument → AnyRef → Any

  42. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  44. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. def →[B](y: B): (BSONDocument, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ExtendedBSONValue from BSONDocument to ExtendedBSONValue[BSONDocument]

Inherited by implicit conversion any2stringadd from BSONDocument to any2stringadd[BSONDocument]

Inherited by implicit conversion StringFormat from BSONDocument to StringFormat[BSONDocument]

Inherited by implicit conversion Ensuring from BSONDocument to Ensuring[BSONDocument]

Inherited by implicit conversion ArrowAssoc from BSONDocument to ArrowAssoc[BSONDocument]

Ungrouped