Class/Object

reactivemongo.bson

BSONDocument

Related Docs: object BSONDocument | package bson

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Value Members

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

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

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

    Permalink
    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

    Permalink

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

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

    Permalink

    Alias for add(doc: BSONDocument): BSONDocument

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

    Permalink

    Alias for remove(names: String*)

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

    Permalink
    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()
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def add(elements: Producer[(String, BSONValue)]*): BSONDocument

    Permalink

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

  10. def add(doc: BSONDocument): BSONDocument

    Permalink

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

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

    Permalink
    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
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def asOpt[T](implicit reader: BSONReader[BSONDocument, T]): Option[T]

    Permalink
    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. def asTry[T](implicit reader: BSONReader[BSONDocument, T]): Try[T]

    Permalink
    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. val bson: BSONDocument

    Permalink
    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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. val code: Byte

    Permalink
    Definition Classes
    BSONDocumentBSONValue
  18. def contains(key: String): Boolean

    Permalink

    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

  19. lazy val elements: Stream[BSONElement]

    Permalink

    Returns a Stream for all the elements of this BSONDocument.

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

    Permalink
    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: (BSONDocument) ⇒ Boolean): BSONDocument

    Permalink
    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. def ensuring(cond: Boolean, msg: ⇒ Any): BSONDocument

    Permalink
    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
  23. def ensuring(cond: Boolean): BSONDocument

    Permalink
    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
  24. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. def finalize(): Unit

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

    Permalink
    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()
  27. def get(key: String): Option[BSONValue]

    Permalink

    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

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

    Permalink

    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.

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

    Permalink

    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

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

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. def getTry(key: String): Try[BSONValue]

    Permalink

    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

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

    Permalink

    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

  34. def isEmpty: Boolean

    Permalink

    Is this document empty?

  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  36. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. def remove(keys: String*): BSONDocument

    Permalink

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

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

    Permalink
    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
  41. def seeAsTry[T](implicit reader: BSONReader[_ <: BSONValue, T]): Try[T]

    Permalink
    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
  42. val stream: Stream[Try[BSONElement]]

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

    Permalink
    Definition Classes
    AnyRef
  44. def toString(): String

    Permalink
    Definition Classes
    BSONDocument → AnyRef → Any
  45. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def [B](y: B): (BSONDocument, B)

    Permalink
    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