class FlattenedCursor[T] extends Cursor[T] with FlattenedCursorCompat[T]
- Alphabetic
- By Inheritance
- FlattenedCursor
- FlattenedCursorCompat
- Cursor
- CursorCompatAPI
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
collect[M[_]](maxDocs: Int, err: ErrorHandler[M[T]])(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]
- Definition Classes
- FlattenedCursorCompat
-
val
cursor: Future[Cursor[T]]
- Attributes
- protected
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[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
import scala.concurrent.ExecutionContext import reactivemongo.api.Cursor case class Person(name: String, age: Int) def foo(cursor: Cursor[Person])(implicit ec: ExecutionContext) = 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
-
final
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
import reactivemongo.api.Cursor import scala.concurrent.ExecutionContext case class Person(name: String, age: Int) def foo(cursor: Cursor[Person])(implicit ec: ExecutionContext) = cursor.foldBulks(Nil: Seq[Person])( (s, bulk: Iterator[Person]) => Cursor.Cont(s ++ bulk), { (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). 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
-
final
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
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.Cursor case class Person(name: String, age: Int) def foo(cursor: Cursor[Person])(implicit ec: ExecutionContext) = cursor.foldBulksM(Nil: Seq[Person])( { (s, bulk: Iterator[Person]) => Future.successful(Cursor.Cont(s ++ bulk)) }, { (l, e) => println("last valid value: " + l) Cursor.Fail[Seq[Person]](e) })
- 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
-
final
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
import reactivemongo.api.Cursor import scala.concurrent.ExecutionContext case class Person(name: String, age: Int) def foo(cursor: Cursor[Person])(implicit ec: ExecutionContext) = 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
-
final
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
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.Cursor case class Person(name: String, age: Int) def foo(cursor: Cursor[Person])(implicit ec: ExecutionContext) = cursor.foldWhileM(Nil: Seq[Person])( (s, p) => Future.successful(Cursor.Cont(s :+ p)), { (l, e) => println("last valid value: " + l) Cursor.Fail[Seq[Person]](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
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
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.
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.bson.BSONDocument import reactivemongo.api.bson.collection.BSONCollection def first(query: BSONDocument)(collection: BSONCollection)( implicit ec: ExecutionContext): Future[BSONDocument] = { val cursor = collection.find(query).cursor[BSONDocument]() // return option of the first element. cursor.head }
- Definition Classes
- FlattenedCursor → Cursor
-
final
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.
import scala.concurrent.{ ExecutionContext, Future } import reactivemongo.api.bson.BSONDocument import reactivemongo.api.bson.collection.BSONCollection def maybeFirst(query: BSONDocument)(collection: BSONCollection)( implicit ec: ExecutionContext): Future[Option[BSONDocument]] = { val cursor = collection.find(query).cursor[BSONDocument]() // return option of the first element. cursor.headOption }
- Definition Classes
- FlattenedCursor → Cursor
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
peek[M[_]](maxDocs: Int)(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[Result[M[T]]]
- Definition Classes
- FlattenedCursorCompat
-
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( ... ) @native()
-
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