reactivemongo.bson

BSONArray

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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BSONArray
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. BSONElementSet
  7. ElementProducer
  8. Producer
  9. BSONValue
  10. AnyRef
  11. Any
Implicitly
  1. by identityValueProducer
  2. by ExtendedBSONValue
  3. by valueProducer
  4. by any2stringadd
  5. by any2stringfmt
  6. by any2ArrowAssoc
  7. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

  1. type SetType = BSONArray

    Definition Classes
    BSONArrayBSONElementSet

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

    Alias for add

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

    Alias for the corresponding merge

    Alias for the corresponding merge

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

    Alias for BSONArray.prepend

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

    Implicit information
    This member is added by an implicit conversion from BSONArray to ArrowAssoc[BSONArray] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  9. 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
    BSONArrayBSONElementSet
  10. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  12. def as[T](implicit reader: BSONReader[BSONArray, T]): T

    Implicit information
    This member is added by an implicit conversion from BSONArray to ExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def asOpt[T](implicit reader: BSONReader[BSONArray, T]): Option[T]

    Implicit information
    This member is added by an implicit conversion from BSONArray to ExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  15. def asTry[T](implicit reader: BSONReader[BSONArray, T]): Try[T]

    Implicit information
    This member is added by an implicit conversion from BSONArray to ExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  16. val bson: BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to ExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  17. def clone(): AnyRef

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

    The code indicating the BSON type for this value

    The code indicating the BSON type for this value

    Definition Classes
    BSONArrayBSONValue
  19. 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
    BSONArrayBSONElementSet
  20. def elements: List[BSONElement]

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

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

    Definition Classes
    BSONArrayBSONElementSet
  21. def ensuring(cond: (BSONArray) ⇒ Boolean, msg: ⇒ Any): BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to Ensuring[BSONArray] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (BSONArray) ⇒ Boolean): BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to Ensuring[BSONArray] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to Ensuring[BSONArray] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to Ensuring[BSONArray] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. def finalize(): Unit

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

    Implicit information
    This member is added by an implicit conversion from BSONArray to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  28. 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
    BSONArrayBSONElementSet
  29. 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.

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

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

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

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

    Definition Classes
    AnyRef → Any
  34. 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.

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

  36. def headOption: Option[BSONElement]

    The first/mandatory nested element, if any

    The first/mandatory nested element, if any

    Definition Classes
    BSONArrayBSONElementSet
  37. def isEmpty: Boolean

    Indicates whether this element set is empty

    Indicates whether this element set is empty

    Definition Classes
    BSONArrayBSONElementSet
    Annotations
    @inline()
  38. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  39. def merge(values: Producer[BSONValue]*): BSONArray

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

  40. def merge(doc: BSONArray): BSONArray

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

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

    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  44. def prepend(value: Producer[BSONValue]): BSONArray

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

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

    Implicit information
    This member is added by an implicit conversion from BSONArray to ExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  46. def seeAsTry[T](implicit reader: BSONReader[_ <: BSONValue, T]): Try[T]

    Implicit information
    This member is added by an implicit conversion from BSONArray to ExtendedBSONValue[BSONArray] performed by method ExtendedBSONValue in reactivemongo.bson.BSONValue.
    Definition Classes
    ExtendedBSONValue
  47. def size: Int

    The number of elements

    The number of elements

    Definition Classes
    BSONArrayBSONElementSet
    Annotations
    @inline()
  48. val stream: Stream[Try[BSONValue]]

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

    Definition Classes
    AnyRef
  50. def toMap: Map[String, BSONValue]

    Returns a Map representation for this element set.

    Returns a Map representation for this element set.

    Definition Classes
    BSONElementSet
  51. def toString(): String

    Definition Classes
    BSONArray → AnyRef → Any
  52. def values: Stream[BSONValue]

    Returns the values for the nested elements.

    Returns the values for the nested elements.

    Definition Classes
    BSONArrayBSONElementSet
  53. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. 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
    BSONArrayBSONElementSet
  57. def [B](y: B): (BSONArray, B)

    Implicit information
    This member is added by an implicit conversion from BSONArray to ArrowAssoc[BSONArray] 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 BSONArray 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:
    (bSONArray: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from BSONArray 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:
    (bSONArray: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to ArrowAssoc[BSONArray] 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:
    (bSONArray: ArrowAssoc[BSONArray]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: BSONArray

    Implicit information
    This member is added by an implicit conversion from BSONArray to Ensuring[BSONArray] 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:
    (bSONArray: Ensuring[BSONArray]).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 BSONElementSet

Inherited from ElementProducer

Inherited from Producer[BSONElement]

Inherited from BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer from BSONArray to Producer[BSONValue]

Inherited by implicit conversion ExtendedBSONValue from BSONArray to ExtendedBSONValue[BSONArray]

Inherited by implicit conversion valueProducer from BSONArray to Producer[BSONValue]

Inherited by implicit conversion any2stringadd from BSONArray to StringAdd

Inherited by implicit conversion any2stringfmt from BSONArray to StringFormat

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

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

Ungrouped