Packages

sealed abstract class BSONDocument extends BSONValue with ElementProducer with BSONDocumentLowPriority with BSONDocumentExperimental

A BSONDocument structure (BSON type 0x03).

A BSONDocument is basically a set of fields (String, BSONValue).

Note: The insertion/initial order of the fields may not be maintained through the operations.

Self Type
BSONDocument
Linear Supertypes
BSONDocumentExperimental, BSONDocumentLowPriority, ElementProducer, Producer[BSONElement], BSONValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONDocument
  2. BSONDocumentExperimental
  3. BSONDocumentLowPriority
  4. ElementProducer
  5. Producer
  6. BSONValue
  7. AnyRef
  8. Any
Implicitly
  1. by identityValueProducer
  2. by valueProducer
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def elements: Seq[BSONElement]

    The document fields as a sequence of BSONElements.

  2. abstract def headOption: Option[BSONElement]

    The first/mandatory element, if any

  3. abstract def isEmpty: Boolean

    Indicates whether this document is empty

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 BSONDocument toany2stringadd[BSONDocument] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. final def ++(seq: BSONElement*): BSONDocument

    Creates a new BSONDocument containing all the elements of this one and the specified element sequence.

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

    Returns the BSONDocument containing all the elements of this one and the elements of the given document.

  6. def ++(producers: ElementProducer*): BSONDocument

    Creates a new BSONDocument containing all the elements of this one and the specified element producers.

    Creates a new BSONDocument containing all the elements of this one and the specified element producers.

    Definition Classes
    BSONDocumentLowPriority
  7. final def --(keys: String*): BSONDocument

    Returns a set without the values corresponding to the specified keys.

  8. def ->[B](y: B): (BSONDocument, B)
    Implicit
    This member is added by an implicit conversion from BSONDocument toArrowAssoc[BSONDocument] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def array(name: String): Option[Seq[BSONValue]]

    EXPERIMENTAL: Returns the named element from the current document, if the element is an array field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is an array field.

    Definition Classes
    BSONDocumentExperimental
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. final def asOpt[T](implicit reader: BSONReader[T]): Option[T]

    Optionally parses this value as a T one.

    Optionally parses this value as a T one.

    returns

    Some successfully parsed value, or None if fails

    import reactivemongo.api.bson.BSONValue

def foo(v: BSONValue): Option[String] = v.asOpt[String]
    Definition Classes
    BSONValue
    Annotations
    @inline()
  13. final def asTry[T](implicit reader: BSONReader[T]): Try[T]

    Tries to parse this value as a T one.

    Tries to parse this value as a T one.

    import scala.util.Try
import reactivemongo.api.bson.BSONValue

def foo(v: BSONValue): Try[String] = v.asTry[String]
    Definition Classes
    BSONValue
  14. def binary(name: String): Option[Array[Byte]]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a binary field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a binary field.

    Definition Classes
    BSONDocumentExperimental
  15. def booleanLike(name: String): Option[Boolean]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a boolean-like field (numeric or boolean).

    EXPERIMENTAL: Returns the named element from the current document, if the element is a boolean-like field (numeric or boolean).

    Definition Classes
    BSONDocumentExperimental
  16. val byteCode: Byte

    The code indicating the BSON type for this value as Byte

    The code indicating the BSON type for this value as Byte

    Definition Classes
    BSONDocument → BSONValue
  17. def child(name: String): Option[BSONDocument]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a nested document.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a nested document.

    Definition Classes
    BSONDocumentExperimental
  18. def children(name: String): List[BSONDocument]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a list of nested documents.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a list of nested documents.

    Definition Classes
    BSONDocumentExperimental
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  20. val code: Int

    The code indicating the BSON type for this value

    The code indicating the BSON type for this value

    Definition Classes
    BSONDocument → BSONValue
  21. def contains(key: String): Boolean

    Checks whether the given key is found in this element set.

    Checks whether the given key is found in this element set.

    key

    the key to be found in the document

    returns

    true if the key is found

  22. def double(name: String): Option[Double]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a double field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a double field.

    Definition Classes
    BSONDocumentExperimental
  23. def ensuring(cond: (BSONDocument) => Boolean, msg: => Any): BSONDocument
    Implicit
    This member is added by an implicit conversion from BSONDocument toEnsuring[BSONDocument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (BSONDocument) => Boolean): BSONDocument
    Implicit
    This member is added by an implicit conversion from BSONDocument toEnsuring[BSONDocument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: => Any): BSONDocument
    Implicit
    This member is added by an implicit conversion from BSONDocument toEnsuring[BSONDocument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): BSONDocument
    Implicit
    This member is added by an implicit conversion from BSONDocument toEnsuring[BSONDocument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(that: Any): Boolean
    Definition Classes
    BSONDocument → AnyRef → Any
  29. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  30. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONDocument toStringFormat[BSONDocument] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  31. final 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 cannot be found, returns None.

    key

    the key to be found in the document

  32. final def getAsOpt[T](key: String)(implicit reader: BSONReader[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.

  33. final def getAsTry[T](key: String)(implicit reader: BSONReader[T]): Try[T]

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

    Gets 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 may hold a exceptions.BSONValueNotFoundException, if the key could not be found.

    key

    the key to be found in the document

  34. final def getAsUnflattenedTry[T](key: String)(implicit reader: BSONReader[T]): Try[Option[T]]

    Gets the BSONValue at the given key, and converts it with the given implicit BSONReader.

    Gets the BSONValue at the given key, and converts it with the given implicit BSONReader.

    If there is no matching value, Success(None) is returned. If there is a value, it must be valid or a Failure is returned.

    key

    the key to be found in the document

  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def hashCode(): Int
    Definition Classes
    BSONDocument → AnyRef → Any
  37. def int(name: String): Option[Int]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a integer field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a integer field.

    Definition Classes
    BSONDocumentExperimental
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. def long(name: String): Option[Long]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a long field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a long field.

    Definition Classes
    BSONDocumentExperimental
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. def size: Int

    The number of fields

    The number of fields

    Annotations
    @inline()
  44. def string(name: String): Option[String]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a string field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a string field.

    Definition Classes
    BSONDocumentExperimental
  45. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  46. final def toMap: Map[String, BSONValue]

    Returns the map representation for this document.

    Returns the map representation for this document.

    Annotations
    @inline()
  47. def toString(): String
    Definition Classes
    BSONDocument → AnyRef → Any
  48. def uuid(name: String): Option[UUID]

    EXPERIMENTAL: Returns the named element from the current document, if the element is a binary/uuid field.

    EXPERIMENTAL: Returns the named element from the current document, if the element is a binary/uuid field.

    Definition Classes
    BSONDocumentExperimental
  49. final def values: Iterable[BSONValue]

    Returns the values of the document fields.

  50. final def values[T](name: String)(implicit r: BSONReader[T]): Option[Seq[T]]
    Definition Classes
    BSONDocumentExperimental
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

Inherited from BSONDocumentLowPriority

Inherited from ElementProducer

Inherited from Producer[BSONElement]

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer fromBSONDocument to Producer[BSONValue]

Inherited by implicit conversion valueProducer fromBSONDocument to Producer[BSONValue]

Inherited by implicit conversion any2stringadd fromBSONDocument to any2stringadd[BSONDocument]

Inherited by implicit conversion StringFormat fromBSONDocument to StringFormat[BSONDocument]

Inherited by implicit conversion Ensuring fromBSONDocument to Ensuring[BSONDocument]

Inherited by implicit conversion ArrowAssoc fromBSONDocument to ArrowAssoc[BSONDocument]

Ungrouped