Packages

object BSONArray

BSONArray utilities

import reactivemongo.api.bson.{ BSONArray, BSONString }

BSONArray("foo", 1) match {
  case BSONArray(BSONString(s) +: _) => s == "foo"
  case _ => false
}
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONArray
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(values: bson.BaseColl[BSONValue]): BSONArray

    Creates a new BSONArray containing all the values in the given Iterable.

    Creates a new BSONArray containing all the values in the given Iterable.

    import reactivemongo.api.bson.{ BSONArray, BSONLong, BSONString }
    
    BSONArray(List(BSONString("foo"), BSONLong(1L)))
    // [ 'foo', NumberLong(1) ]
  5. def apply(values: IndexedSeq[BSONValue]): BSONArray

    Creates a new BSONArray containing all the values in the given sequence.

    Creates a new BSONArray containing all the values in the given sequence.

    import reactivemongo.api.bson.{ BSONArray, BSONLong, BSONString }
    
    BSONArray(Seq(BSONString("foo"), BSONLong(1L)))
    // [ 'foo', NumberLong(1) ]
  6. def apply(values: Producer[BSONValue]*): BSONArray

    Creates a new BSONArray containing all the values.

    Creates a new BSONArray containing all the values. In case of conversion error for a field value, the field is ignored.

    reactivemongo.api.bson.BSONArray("foo", 1L)
    // [ 'foo', NumberLong(1) ]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. val empty: BSONArray

    An empty BSONArray.

    An empty BSONArray.

    import reactivemongo.api.bson.{ BSONArray, BSONString }
    
    val initial = BSONArray.empty // []
    
    initial ++ BSONString("lorem") // [ 'lorem' ]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def pretty(array: BSONArray): String

    Returns a String representing the given BSONArray.

    Returns a String representing the given BSONArray.

    import reactivemongo.api.bson.BSONArray
    
    BSONArray pretty BSONArray("foo", 1L)
    // "[ 'foo', NumberLong(1) ]"
  20. def safe(values: Producer[BSONValue]*): Try[BSONArray]

    Creates a new BSONArray containing all the values.

    Creates a new BSONArray containing all the values. Fails if any error occurs while converting the values.

    reactivemongo.api.bson.BSONArray.safe("foo", 1L)
    // Success: [ 'foo', NumberLong(1) ]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def unapply(that: Any): Option[IndexedSeq[BSONValue]]

    Extracts the values sequence if that's a BSONArray.

    Extracts the values sequence if that's a BSONArray.

    import reactivemongo.api.bson.{ BSONArray, BSONValue }
    
    def foo(input: BSONValue): Unit = input match {
      case BSONArray(vs) => pretty(vs)
      case _ => println("Not a BSON array")
    }
    
    def bar(arr: BSONArray): Unit = arr match {
      // with splat pattern
      case BSONArray(Seq(requiredFirst, other @ _*)) =>
        println(s"first = \$requiredFirst")
        pretty(other)
    
      case _ =>
        println("BSON array doesn't match")
    }
    
    def pretty(values: Seq[BSONValue]): Unit =
      println(values.map(BSONValue.pretty).mkString(", "))
    Annotations
    @inline()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped