Cursor

Abstract Value Members

abstract 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())
```
abstract def foldBulks[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Iterator[T]) ⇒ State[A], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: 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.
abstract def foldBulksM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: 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.
abstract def foldResponses[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Response) ⇒ State[A], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: 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.
abstract def foldResponsesM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Response) ⇒ Future[State[A]], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: 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.
abstract def foldWhile[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ State[A], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: 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.
abstract def foldWhileM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ Future[State[A]], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: 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.
abstract def head(implicit ctx: 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
```
abstract def enumerate(maxDocs: Int = 1, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[T]

Produces an Enumerator of documents.
Produces an Enumerator of documents. The returned enumerator may process up to maxDocs. If stopOnError is false, then documents that cause error are dropped, so the enumerator may emit a little less than maxDocs, even if it processes maxDocs documents.
maxDocs
the maximum number of documents to be retrieved (-1 for unlimited).
stopOnError
States if may stop on non-fatal exception (default: true). If set to false, the exceptions are skipped, trying to get the next result..
returns
an play.api.libs.iteratee.Enumerator of documents

Annotations
@deprecated
Deprecated
(Since version 0.11.10) Use .enumerator from Play Iteratees module
abstract def enumerateBulks(maxDocs: Int = 1, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

Produces an Enumerator of Iterator of documents.
Produces an Enumerator of Iterator of documents. Given the stopOnError parameter, this Enumerator may stop on any non-fatal exception, or skip and continue.
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.
stopOnError
States if may stop on non-fatal exception (default: true). If set to false, the exceptions are skipped, trying to get the next result..
returns
an play.api.libs.iteratee.Enumerator of Iterators of documents

Annotations
@deprecated
Deprecated
(Since version 0.11.10) Use .bulkEnumerator from the Play Iteratees module
abstract def enumerateResponses(maxDocs: Int = 1, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[Response]

Produces an Enumerator of responses from the database.
Produces an Enumerator of responses from the database. Given the stopOnError parameter, this Enumerator may stop on any non-fatal exception, or skip and continue.
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.
stopOnError
States if may stop on non-fatal exception (default: true). If set to false, the exceptions are skipped, trying to get the next result..
returns
an play.api.libs.iteratee.Enumerator of Responses.

Annotations
@deprecated
Deprecated
(Since version 0.11.10) Use .responseEnumerator from the Play Iteratees module
abstract def rawEnumerateResponses(maxDocs: Int = 1)(implicit ctx: ExecutionContext): Enumerator[Response]

Produces an Enumerator of responses from the database.
Produces an Enumerator of responses from the database. An Enumeratee for error handling should be used to prevent silent failures.
maxDocs
the maximum number of documents to be retrieved (-1 for unlimited)

Annotations
@deprecated
Deprecated
(Since version 0.11.10) Use the Play Iteratees module

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Cursor[T] to any2stringadd[Cursor[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Cursor[T], B)

Implicit information
This member is added by an implicit conversion from Cursor[T] to ArrowAssoc[Cursor[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (Cursor[T]) ⇒ Boolean, msg: ⇒ Any): Cursor[T]

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

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

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

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fold[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ A)(implicit ctx: 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.
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Cursor[T] to StringFormat[Cursor[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any

def headOption(implicit ctx: ExecutionContext): Future[Option[T]]

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

final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Cursor[T], B)

Implicit information
This member is added by an implicit conversion from Cursor[T] to ArrowAssoc[Cursor[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Deprecated Value Members

def collect[M[_]](maxDocs: Int = 1, stopOnError: Boolean = true)(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).
stopOnError
States if may stop on non-fatal exception (default: true). If set to false, the exceptions are skipped, trying to get the next result..
```
val cursor = collection.find(query, filter).cursor[BSONDocument]
// return the 3 first documents in a Vector[BSONDocument].
val vector = cursor.collect[Vector](3)
```
Annotations
@deprecated
Deprecated
(Since version 0.12-RC1) Use collect with an Cursor.ErrorHandler.
def toList(maxDocs: Int = 1, stopOnError: Boolean = true)(implicit ctx: ExecutionContext): Future[List[T]]

Returns the list of the matching documents.
Returns the list of the matching documents.

Annotations
@deprecated
Deprecated
(Since version 0.10.0) consider using collect[List] instead

Related Docs: object Cursor | package api

trait Cursor[T] extends AnyRef

Abstract Value Members

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

abstract def foldBulks[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Iterator[T]) ⇒ State[A], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: ExecutionContext): Future[A]

abstract def foldBulksM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: ExecutionContext): Future[A]

abstract def foldResponses[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Response) ⇒ State[A], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: ExecutionContext): Future[A]

abstract def foldResponsesM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Response) ⇒ Future[State[A]], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: ExecutionContext): Future[A]

abstract def foldWhile[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ State[A], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: ExecutionContext): Future[A]

abstract def foldWhileM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ Future[State[A]], err: ErrorHandler[A] = FailOnError[A]())(implicit ctx: ExecutionContext): Future[A]

abstract def head(implicit ctx: ExecutionContext): Future[T]

abstract def enumerate(maxDocs: Int = 1, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[T]

abstract def enumerateBulks(maxDocs: Int = 1, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

abstract def enumerateResponses(maxDocs: Int = 1, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[Response]

abstract def rawEnumerateResponses(maxDocs: Int = 1)(implicit ctx: ExecutionContext): Enumerator[Response]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Cursor[T], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Cursor[T]) ⇒ Boolean, msg: ⇒ Any): Cursor[T]

def ensuring(cond: (Cursor[T]) ⇒ Boolean): Cursor[T]

def ensuring(cond: Boolean, msg: ⇒ Any): Cursor[T]

def ensuring(cond: Boolean): Cursor[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fold[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ A)(implicit ctx: ExecutionContext): Future[A]

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

def headOption(implicit ctx: ExecutionContext): Future[Option[T]]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (Cursor[T], B)

Deprecated Value Members

def collect[M[_]](maxDocs: Int = 1, stopOnError: Boolean = true)(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

def toList(maxDocs: Int = 1, stopOnError: Boolean = true)(implicit ctx: ExecutionContext): Future[List[T]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Cursor[T] to any2stringadd[Cursor[T]]

Inherited by implicit conversion StringFormat from Cursor[T] to StringFormat[Cursor[T]]

Inherited by implicit conversion Ensuring from Cursor[T] to Ensuring[Cursor[T]]

Inherited by implicit conversion ArrowAssoc from Cursor[T] to ArrowAssoc[Cursor[T]]

Ungrouped