Packages

case class BSONArray(stream: Stream[Try[BSONValue]]) extends BSONValue with BSONElementSet with Product with Serializable

A BSONArray structure (BSON type 0x04).

A BSONArray is a straightforward BSONDocument where keys are a sequence of positive integers.

A BSONArray is basically a stream of tuples (String, BSONValue) where the first member is a string representation of an index. 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, Product, Equals, BSONElementSet, ElementProducer, Producer[BSONElement], BSONValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONArray
  2. Serializable
  3. Product
  4. Equals
  5. BSONElementSet
  6. ElementProducer
  7. Producer
  8. BSONValue
  9. AnyRef
  10. Any
Implicitly
  1. by identityValueProducer
  2. by valueProducer
  3. by ExtendedBSONValue
  4. by any2stringadd
  5. by StringFormat
  6. by Ensuring
  7. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new BSONArray(stream: Stream[Try[BSONValue]])

Type Members

  1. type SetType = BSONArray
    Definition Classes
    BSONArray → BSONElementSet

Value Members

  1. def ++(values: Producer[BSONValue]*): BSONArray

    Alias for add

  2. def ++(array: BSONArray): BSONArray

    Alias for the corresponding merge

    Alias for the corresponding merge

    Annotations
    @inline()
  3. def +:(value: Producer[BSONValue]): BSONArray

    Alias for BSONArray.prepend

  4. def :~(elements: Producer[BSONElement]*): BSONArray

    The name of the produced elements are ignored, instead the indexes are used.

    The name of the produced elements are ignored, instead the indexes are used.

    Definition Classes
    BSONArray → BSONElementSet
  5. def as[T](implicit reader: BSONReader[BSONArray, T]): T
    Implicit
    This member is added by an implicit conversion from BSONArray toExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  6. def asOpt[T](implicit reader: BSONReader[BSONArray, T]): Option[T]
    Implicit
    This member is added by an implicit conversion from BSONArray toExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  7. def asTry[T](implicit reader: BSONReader[BSONArray, T]): Try[T]
    Implicit
    This member is added by an implicit conversion from BSONArray toExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  8. val bson: BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  9. val code: Byte

    The code indicating the BSON type for this value

    The code indicating the BSON type for this value

    Definition Classes
    BSONArray → BSONValue
  10. def contains(name: String): Boolean

    Returns true if the given name corresponds to a valid index.

    Returns true if the given name corresponds to a valid index.

    returns

    true if the key is found

    Definition Classes
    BSONArray → BSONElementSet
  11. def elements: List[BSONElement]

    Returns a list for the values as BSONElements, with their indexes as names (e.g.

    Returns a list for the values as BSONElements, with their indexes as names (e.g. "0" for the first).

    Definition Classes
    BSONArray → BSONElementSet
  12. def get(name: String): Option[BSONValue]

    Returns the BSONValue matching the given name, provided it is a valid string representation of a valid index.

    Returns the BSONValue matching the given name, provided it is a valid string representation of a valid index.

    Definition Classes
    BSONArray → BSONElementSet
  13. def get(index: Int): Option[BSONValue]

    Returns the BSONValue at the given index.

    Returns the BSONValue at the given index.

    If there is no such index or the matching value cannot be deserialized, returns None.

  14. def getAs[T](index: Int)(implicit reader: BSONReader[_ <: BSONValue, T]): Option[T]

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

    Gets the BSONValue at the given index, 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.

  15. def getAsTry[T](index: Int)(implicit reader: BSONReader[_ <: BSONValue, T]): Try[T]

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

    Gets the BSONValue at the given index, 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.

  16. def getAsUnflattenedTry[T](index: Int)(implicit reader: BSONReader[_ <: BSONValue, T]): Try[Option[T]]

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

    Gets the BSONValue at the given index, 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.

  17. def getTry(index: Int): Try[BSONValue]

    Returns the BSONValue at the given index.

    Returns the BSONValue at the given index.

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

  18. def getUnflattenedTry(index: Int): Try[Option[BSONValue]]

    Returns the BSONValue at the given index.

    Returns the BSONValue at the given index.

    If there is no such index, the resulting option will be None. If the matching value could not be deserialized, returns a Failure.

  19. def headOption: Option[BSONElement]

    The first/mandatory nested element, if any

    The first/mandatory nested element, if any

    Definition Classes
    BSONArray → BSONElementSet
  20. def isEmpty: Boolean

    Indicates whether this element set is empty

    Indicates whether this element set is empty

    Definition Classes
    BSONArray → BSONElementSet
    Annotations
    @inline()
  21. def merge(values: Producer[BSONValue]*): BSONArray

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

  22. def merge(doc: BSONArray): BSONArray

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

  23. def prepend(value: Producer[BSONValue]): BSONArray

    Returns a BSONArray with the given value prepended to its elements.

  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def seeAsOpt[T](implicit reader: BSONReader[_ <: BSONValue, T]): Option[T]
    Implicit
    This member is added by an implicit conversion from BSONArray toExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  26. def seeAsTry[T](implicit reader: BSONReader[_ <: BSONValue, T]): Try[T]
    Implicit
    This member is added by an implicit conversion from BSONArray toExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  27. def size: Int

    The number of elements

    The number of elements

    Definition Classes
    BSONArray → BSONElementSet
    Annotations
    @inline()
  28. val stream: Stream[Try[BSONValue]]
  29. def toMap: Map[String, BSONValue]

    Returns a Map representation for this element set.

    Returns a Map representation for this element set.

    Definition Classes
    BSONElementSet
  30. def toString(): String
    Definition Classes
    BSONArray → AnyRef → Any
  31. def values: Stream[BSONValue]

    Returns the values for the nested elements.

    Returns the values for the nested elements.

    Definition Classes
    BSONArray → BSONElementSet
  32. def ~:(elements: Producer[BSONElement]): BSONArray

    Merge the produced elements at the beginning of this set

    Merge the produced elements at the beginning of this set

    Definition Classes
    BSONArray → BSONElementSet