t

reactivemongo.api

CursorCompatAPI

trait CursorCompatAPI[T] extends AnyRef

Cursor over results from MongoDB.

T

the type parsed from each result document

Self Type
Cursor[T]
Linear Supertypes
AnyRef, Any
Known Subclasses
Cursor, FlattenedCursor, WrappedCursor
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CursorCompatAPI
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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.

    import scala.concurrent.ExecutionContext

import reactivemongo.api.Cursor
import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONCollection

def foo(collection: BSONCollection, query: BSONDocument)(
  implicit ec: ExecutionContext) = {
  val cursor = collection.find(query).cursor[BSONDocument]()
  // return the 3 first documents in a Vector[BSONDocument].
  cursor.collect[Vector](3, Cursor.FailOnError[Vector[BSONDocument]]())
}

Concrete 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 CursorCompatAPI[T] to any2stringadd[CursorCompatAPI[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CursorCompatAPI[T], B)
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to ArrowAssoc[CursorCompatAPI[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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def ensuring(cond: (CursorCompatAPI[T]) ⇒ Boolean, msg: ⇒ Any): CursorCompatAPI[T]
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to Ensuring[CursorCompatAPI[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (CursorCompatAPI[T]) ⇒ Boolean): CursorCompatAPI[T]
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to Ensuring[CursorCompatAPI[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): CursorCompatAPI[T]
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to Ensuring[CursorCompatAPI[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): CursorCompatAPI[T]
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to Ensuring[CursorCompatAPI[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to StringFormat[CursorCompatAPI[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def →[B](y: B): (CursorCompatAPI[T], B)
    Implicit
    This member is added by an implicit conversion from CursorCompatAPI[T] to ArrowAssoc[CursorCompatAPI[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped