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 FlattenedCursor[T] to any2stringadd[FlattenedCursor[T]] performed by method any2stringadd in scala.Predef.

   Definition Classes

   any2stringadd

4.  def ->[B](y: B): (FlattenedCursor[T], B)

   Implicit

   This member is added by an implicit conversion from FlattenedCursor[T] to ArrowAssoc[FlattenedCursor[T]] performed by method ArrowAssoc in scala.Predef.

   Definition Classes

   ArrowAssoc

   Annotations

   @inline()

5.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

6.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

8.  def collect[M[_]](maxDocs: Int, err: ErrorHandler[M[T]])(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

   Collects all the documents into a collection of type M[T].

   Collects all the documents into a collection of type M[T].

   maxDocs

   the maximum number of documents to be retrieved (-1 for unlimited).

   err

   The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

   val cursor = collection.find(query, filter).cursor[BSONDocument]()
   // return the 3 first documents in a Vector[BSONDocument].
   val vector = cursor.collect[Vector](3, Cursor.FailOnError[Vector[BSONDocument]]())

   Definition Classes

   FlattenedCursor → Cursor

9.  def ensuring(cond: (FlattenedCursor[T]) ⇒ Boolean, msg: ⇒ Any): FlattenedCursor[T]

   Implicit

   This member is added by an implicit conversion from FlattenedCursor[T] to Ensuring[FlattenedCursor[T]] performed by method Ensuring in scala.Predef.

   Definition Classes

   Ensuring

10.  def ensuring(cond: (FlattenedCursor[T]) ⇒ Boolean): FlattenedCursor[T]

    Implicit

    This member is added by an implicit conversion from FlattenedCursor[T] to Ensuring[FlattenedCursor[T]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

11.  def ensuring(cond: Boolean, msg: ⇒ Any): FlattenedCursor[T]

    Implicit

    This member is added by an implicit conversion from FlattenedCursor[T] to Ensuring[FlattenedCursor[T]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

12.  def ensuring(cond: Boolean): FlattenedCursor[T]

    Implicit

    This member is added by an implicit conversion from FlattenedCursor[T] to Ensuring[FlattenedCursor[T]] performed by method Ensuring in scala.Predef.

    Definition Classes

    Ensuring

13.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

14.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

15.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

16.  def fold[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, T) ⇒ A)(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all elements retrieved by this cursor, going first to last.

    Applies a binary operator to a start value and all elements retrieved by this cursor, going first to last.

    A

    the result type of the binary operator

    cursor.foldWhile(Nil: Seq[Person])((s, p) => Cursor.Cont(s :+ p),
      { (l, e) => println("last valid value: " + l); Cursor.Fail(e) })

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited).

    suc

    The binary operator to be applied when the next document is successfully read.

    Definition Classes

    Cursor

17.  def foldBulks[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, Iterator[T]) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all bulks of documents retrieved by this cursor, going first to last.

    Applies a binary operator to a start value and all bulks of documents retrieved by this cursor, going first to last.

    A

    the result type of the binary operator

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited). The actual document count can exceed this, when this maximum devided by the batch size given a non-zero remainder.

    suc

    The binary operator to be applied when the next response is successfully read.

    err

    The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

    Definition Classes

    FlattenedCursor → Cursor

18.  def foldBulksM[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all bulks of documents retrieved by this cursor, going first to last.

    Applies a binary operator to a start value and all bulks of documents retrieved by this cursor, going first to last.

    A

    the result type of the binary operator

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited). The actual document count can exceed this, when this maximum devided by the batch size given a non-zero remainder.

    suc

    The binary operator to be applied when the next response is successfully read. This must be safe, and any error must be returned as Future.failed[State[A]].

    err

    The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

    Definition Classes

    FlattenedCursor → Cursor

19.  def foldResponses[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, Response) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all responses handled by this cursor, going first to last.

    Applies a binary operator to a start value and all responses handled by this cursor, going first to last.

    A

    the result type of the binary operator

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited). The actual document count can exceed this, when this maximum devided by the batch size given a non-zero remainder.

    suc

    The binary operator to be applied when the next response is successfully read.

    err

    The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

    Definition Classes

    FlattenedCursor → Cursor

20.  def foldResponsesM[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, Response) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all responses handled by this cursor, going first to last.

    Applies a binary operator to a start value and all responses handled by this cursor, going first to last.

    A

    the result type of the binary operator

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited). The actual document count can exceed this, when this maximum devided by the batch size given a non-zero remainder.

    suc

    The binary operator to be applied when the next response is successfully read. This must be safe, and any error must be returned as Future.failed[State[A]].

    err

    The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

    Definition Classes

    FlattenedCursor → Cursor

21.  def foldWhile[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, T) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all elements retrieved by this cursor, going first to last.

    Applies a binary operator to a start value and all elements retrieved by this cursor, going first to last.

    A

    the result type of the binary operator

    cursor.foldWhile(Nil: Seq[Person])((s, p) => Cursor.Cont(s :+ p),
      { (l, e) => println("last valid value: " + l); Cursor.Fail(e) })

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited).

    suc

    The binary operator to be applied when the next document is successfully read.

    err

    The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

    Definition Classes

    FlattenedCursor → Cursor

22.  def foldWhileM[A](z: ⇒ A, maxDocs: Int = -1)(suc: (A, T) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

    Applies a binary operator to a start value and all elements retrieved by this cursor, going first to last.

    Applies a binary operator to a start value and all elements retrieved by this cursor, going first to last.

    A

    the result type of the binary operator

    cursor.foldWhileM(Nil: Seq[Person])(
      (s, p) => Future.successful(Cursor.Cont(s :+ p)),
      { (l, e) => Future {
        println("last valid value: " + l)
        Cursor.Fail(e)
      })

    z

    the initial value

    maxDocs

    the maximum number of documents to be retrieved (-1 for unlimited).

    suc

    The binary operator to be applied when the next document is successfully read. This must be safe, and any error must be returned as Future.failed[State[A]].

    err

    The binary operator to be applied when failing to get the next response. Exception or Fail raised within the suc function cannot be recovered by this error handler.

    Definition Classes

    FlattenedCursor → Cursor

23.  def formatted(fmtstr: String): String

    Implicit

    This member is added by an implicit conversion from FlattenedCursor[T] to StringFormat[FlattenedCursor[T]] performed by method StringFormat in scala.Predef.

    Definition Classes

    StringFormat

    Annotations

    @inline()

24.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

25.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

26.  def head(implicit ec: ExecutionContext): Future[T]

    Returns the first document matching the query, or fails with Cursor.NoSuchResultException if none.

    Returns the first document matching the query, or fails with Cursor.NoSuchResultException if none.

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return option of the first element.
    val first: Future[BSONDocument] = cursor.head

    Definition Classes

    FlattenedCursor → Cursor

27.  def headOption(implicit ec: ExecutionContext): Future[Option[T]]

    Returns the first document matching the query, if any.

    Returns the first document matching the query, if any.

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return option of the first element.
    val maybeFirst: Future[Option[BSONDocument]] = cursor.headOption

    Definition Classes

    FlattenedCursor → Cursor

28.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

29.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

30.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

31.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

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

    Definition Classes

    AnyRef

33.  def toString(): String

    Definition Classes

    AnyRef → Any

34.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

36.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )

37.  def →[B](y: B): (FlattenedCursor[T], B)

    Implicit

    This member is added by an implicit conversion from FlattenedCursor[T] to ArrowAssoc[FlattenedCursor[T]] performed by method ArrowAssoc in scala.Predef.

    Definition Classes

    ArrowAssoc