Cursor

Abstract Value Members

abstract def collect[M[_]](upTo: Int = Int.MaxValue, 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]. Given the stopOnError parameter (which defaults to true), the resulting Future may fail if any non-fatal exception occurs. If set to false, all the documents that caused exceptions are skipped. Up to maxDocs returned by the database may be processed. If stopOnError is false, then documents that cause error are dropped, so the result may contain a little less than maxDocs even if maxDocs documents were processed.
upTo
Collect up to upTo documents.
stopOnError
States if the Future should fail if any non-fatal exception occurs.
Example:
```
val cursor = collection.find(query, filter).cursor[BSONDocument]
// return the 3 first documents in a Vector[BSONDocument].
val vector = cursor.collect[Vector](3)
```
abstract def enumerate(maxDocs: Int = Int.MaxValue, stopOnError: Boolean = false)(implicit ctx: ExecutionContext): Enumerator[T]

Produces an Enumerator of documents.
Produces an Enumerator of documents. Given the stopOnError parameter, this Enumerator may stop on any non-fatal exception, or skip and continue. 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
Enumerate up to maxDocs documents.
stopOnError
States if the produced Enumerator may stop on non-fatal exception.
returns
an Enumerator of documents.
abstract def enumerateBulks(maxDocs: Int = Int.MaxValue, 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
Enumerate up to maxDocs documents.
stopOnError
States if the produced Enumerator may stop on non-fatal exception.
returns
an Enumerator of Iterators of documents.
abstract def enumerateResponses(maxDocs: Int = Int.MaxValue, 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
Enumerate up to maxDocs documents.
stopOnError
States if the produced Enumerator may stop on non-fatal exception.
returns
an Enumerator of Responses.
abstract def foldBulks[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Iterator[T]) ⇒ State[A], err: (A, Throwable) ⇒ State[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 start value.
maxDocs
the maximum number of documents to be read.
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.
abstract def foldResponses[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Response) ⇒ State[A], err: (A, Throwable) ⇒ State[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 start value.
maxDocs
the maximum number of documents to be read.
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.
abstract def foldWhile[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, T) ⇒ State[A], err: (A, Throwable) ⇒ State[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.
z
the start value.
maxDocs
the maximum number of documents to be read.
suc
the binary operator to be applied when the next document is successfully read.
err
the binary operator to be applied when failing to read the next document.
```
cursor.foldWhile(Nil: Seq[Person])((s, p) => Cursor.Cont(s :+ p),
{ (l, e) => println("last valid value: " + l); Cursor.Fail(e) })
```
abstract def rawEnumerateResponses(maxDocs: Int = Int.MaxValue)(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. Consider using enumerateResponses instead.
maxDocs
Enumerate up to maxDocs documents.
returns
an Enumerator of Responses.

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 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]]

Gets the first document matching the query, if any.
Gets the first document matching the query, if any. The resulting Future may fail if any exception occurs (for example, while deserializing the document).
Example:
```
val cursor = collection.find(query, filter).cursor[BSONDocument]
// return option of the first element.
val first: 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 toList(upTo: Int = Int.MaxValue, stopOnError: Boolean = true)(implicit ctx: ExecutionContext): Future[List[T]]

Collects all the documents into a List[T].
Collects all the documents into a List[T]. Given the stopOnError parameter (which defaults to true), the resulting Future may fail if any non-fatal exception occurs. If set to false, all the documents that caused exceptions are skipped.
upTo
Collect up to maxDocs documents.
stopOnError
States if the Future should fail if any non-fatal exception occurs.
Example:
```
val cursor = collection.find(query, filter).cursor[BSONDocument]
// return the 3 first documents in a list.
val list = cursor.toList(3)
```
Annotations
@deprecated
Deprecated
(Since version 0.10.0) consider using collect[List] instead

trait Cursor[T] extends AnyRef

Abstract Value Members

abstract def collect[M[_]](upTo: Int = Int.MaxValue, stopOnError: Boolean = true)(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

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

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

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

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

abstract def foldResponses[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Response) ⇒ State[A], err: (A, Throwable) ⇒ State[A])(implicit ctx: ExecutionContext): Future[A]

abstract def foldWhile[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, T) ⇒ State[A], err: (A, Throwable) ⇒ State[A])(implicit ctx: ExecutionContext): Future[A]

abstract def rawEnumerateResponses(maxDocs: Int = Int.MaxValue)(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 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 toList(upTo: Int = Int.MaxValue, 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