reactivemongo.bson

BSONDocument

case class BSONDocument(stream: Stream[Try[(String, BSONValue)]]) 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 any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BSONDocument(stream: Stream[Try[(String, BSONValue)]])

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

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

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

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

    Alias for add(doc: BSONDocument): BSONDocument

  7. def --(keys: String*): BSONDocument

    Alias for remove(names: String*)

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

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

  9. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

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

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

  12. def add(doc: BSONDocument): BSONDocument

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

  13. 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

  14. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  15. 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

  16. 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

  17. 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

  18. def clone(): AnyRef

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

  19. val code: Byte

    Definition Classes
    BSONDocument → BSONValue

  20. def contains(key: String): Boolean

    Checks whether the given key is found in the document.

    Checks whether the given key is found in the document.

    key

    the key to be found in the document

    returns

    true if the key is found

  21. lazy val elements: Stream[(String, BSONValue)]

    Returns a Stream for all the elements of this BSONDocument.

  22. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

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

  24. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  25. def ensuring(cond: Boolean): BSONDocument

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

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

    Definition Classes
    AnyRef

  27. def finalize(): Unit

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

  28. def formatted(fmtstr: String): String

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

  29. 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.

    key

    the key to be found in the document

  30. def getAs[T](key: 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.

    key

    the key to be found in the document

    Note

    When implementing a custom reader, getAsTry must be preferred.

  31. def getAsTry[T](key: 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.

    key

    the key to be found in the document

  32. def getAsUnflattenedTry[T](key: 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.

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

    Definition Classes
    AnyRef → Any

  34. 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.

    key

    the key to be found in the document

  35. 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.

    key

    the key to be found in the document

  36. def isEmpty: Boolean

    Is this document empty?

  37. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  39. final def notify(): Unit

    Definition Classes
    AnyRef

  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  41. def remove(keys: String*): BSONDocument

    Creates a new BSONDocument without the elements corresponding the given keys.

  42. 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

  43. 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

  44. val stream: Stream[Try[(String, BSONValue)]]

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

    Definition Classes
    AnyRef

  46. def toString(): String

    Definition Classes
    BSONDocument → AnyRef → Any

  47. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from BSONDocument to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bSONDocument: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BSONDocument to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bSONDocument: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BSONDocument

    Implicit information
    This member is added by an implicit conversion from BSONDocument to ArrowAssoc[BSONDocument] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bSONDocument: ArrowAssoc[BSONDocument]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BSONDocument

    Implicit information
    This member is added by an implicit conversion from BSONDocument to Ensuring[BSONDocument] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (bSONDocument: Ensuring[BSONDocument]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from BSONDocument to StringFormat

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

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

Ungrouped