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. 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 BSONArray toany2stringadd[BSONArray] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ++(values: Producer[BSONValue]*): BSONArray

    Alias for add

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

    Alias for the corresponding merge

    Alias for the corresponding merge

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

    Alias for BSONArray.prepend

  7. def ->[B](y: B): (BSONArray, B)
    Implicit
    This member is added by an implicit conversion from BSONArray toArrowAssoc[BSONArray] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  8. 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
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. 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
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. 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
  13. 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
  14. 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
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  16. 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
  17. 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
  18. 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
  19. def ensuring(cond: (BSONArray) => Boolean, msg: => Any): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (BSONArray) => Boolean): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: => Any): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean): BSONArray
    Implicit
    This member is added by an implicit conversion from BSONArray toEnsuring[BSONArray] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONArray toStringFormat[BSONArray] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. 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
  26. 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.

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

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

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

  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. 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.

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

  33. def headOption: Option[BSONElement]

    The first/mandatory nested element, if any

    The first/mandatory nested element, if any

    Definition Classes
    BSONArray → BSONElementSet
  34. def isEmpty: Boolean

    Indicates whether this element set is empty

    Indicates whether this element set is empty

    Definition Classes
    BSONArray → BSONElementSet
    Annotations
    @inline()
  35. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  36. def merge(values: Producer[BSONValue]*): BSONArray

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

  37. def merge(doc: BSONArray): BSONArray

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

  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. def prepend(value: Producer[BSONValue]): BSONArray

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

  42. def productElementNames: Iterator[String]
    Definition Classes
    Product
  43. 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
  44. 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
  45. def size: Int

    The number of elements

    The number of elements

    Definition Classes
    BSONArray → BSONElementSet
    Annotations
    @inline()
  46. val stream: Stream[Try[BSONValue]]
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toMap: Map[String, BSONValue]

    Returns a Map representation for this element set.

    Returns a Map representation for this element set.

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

    Returns the values for the nested elements.

    Returns the values for the nested elements.

    Definition Classes
    BSONArray → BSONElementSet
  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()
  54. 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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

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

Inherited from Product

Inherited from Equals

Inherited from BSONElementSet

Inherited from ElementProducer

Inherited from Producer[BSONElement]

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer fromBSONArray to Producer[BSONValue]

Inherited by implicit conversion valueProducer fromBSONArray to Producer[BSONValue]

Inherited by implicit conversion ExtendedBSONValue fromBSONArray to ExtendedBSONValue[BSONArray]

Inherited by implicit conversion any2stringadd fromBSONArray to any2stringadd[BSONArray]

Inherited by implicit conversion StringFormat fromBSONArray to StringFormat[BSONArray]

Inherited by implicit conversion Ensuring fromBSONArray to Ensuring[BSONArray]

Inherited by implicit conversion ArrowAssoc fromBSONArray to ArrowAssoc[BSONArray]

Ungrouped