Cursor

Abstract Value Members

abstract def collect[M[_]](maxDocs: Int, err: (M[T], Throwable) ⇒ State[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]]())
```
abstract def foldBulks[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Iterator[T]) ⇒ State[A], err: (A, Throwable) ⇒ State[A] = FailOnError[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.
abstract def foldBulksM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: (A, Throwable) ⇒ State[A] = FailOnError[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.
abstract def foldResponses[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Response) ⇒ State[A], err: (A, Throwable) ⇒ State[A] = FailOnError[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.
abstract def foldResponsesM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, Response) ⇒ Future[State[A]], err: (A, Throwable) ⇒ State[A] = FailOnError[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.
abstract def foldWhile[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ State[A], err: (A, Throwable) ⇒ State[A] = FailOnError[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.
abstract def foldWhileM[A](z: ⇒ A, maxDocs: Int = 1)(suc: (A, T) ⇒ Future[State[A]], err: (A, Throwable) ⇒ State[A] = FailOnError[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.
abstract 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
```
abstract 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
```

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
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 StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
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 any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

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

Definition Classes
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 any2Ensuring 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 any2Ensuring 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 any2Ensuring 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 any2Ensuring 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 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.
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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 any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from Cursor[T] 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:
(cursor: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from Cursor[T] 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:
(cursor: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: Cursor[T]
Implicit information
This member is added by an implicit conversion from Cursor[T] to ArrowAssoc[Cursor[T]] 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:
(cursor: ArrowAssoc[Cursor[T]]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: Cursor[T]
Implicit information
This member is added by an implicit conversion from Cursor[T] to Ensuring[Cursor[T]] 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:
(cursor: Ensuring[Cursor[T]]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

trait Cursor[T] extends AnyRef

Abstract Value Members

abstract def collect[M[_]](maxDocs: Int, err: (M[T], Throwable) ⇒ State[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: (A, Throwable) ⇒ State[A] = FailOnError[A]())(implicit ec: ExecutionContext): Future[A]

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

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

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

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

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

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

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

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: AnyRef): Boolean

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 ec: ExecutionContext): Future[A]

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

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)

Shadowed Implicit Value Members

val self: Any

val self: Any

Deprecated Value Members

def x: Cursor[T]

def x: Cursor[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped