Trait

reactivemongo.api

WrappedCursor

Related Doc: package api

Permalink

trait WrappedCursor[T] extends Cursor[T]

Cursor wrapper, to help to define custom cursor classes.

See also

CursorProducer

Linear Supertypes
Cursor[T], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WrappedCursor
  2. Cursor
  3. AnyRef
  4. 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 wrappee: Cursor[T]

    Permalink

    The underlying cursor

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def collect[M[_]](maxDocs: Int = Int.MaxValue, stopOnError: Boolean = true)(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

    Permalink

    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.

    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.. Example:

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return the 3 first documents in a Vector[BSONDocument].
    val vector = cursor.collect[Vector](3)
    Definition Classes
    WrappedCursorCursor
  9. def collect[M[_]](maxDocs: Int, err: ErrorHandler[M[T]])(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

    Permalink

    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.

    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. Example:

    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())
    Definition Classes
    WrappedCursorCursor
  10. def documentIterator(response: Response)(implicit ec: ExecutionContext): Future[Iterator[T]]

    Permalink

    Returns an iterator to read the response documents, according the provided read for the element type T.

    Returns an iterator to read the response documents, according the provided read for the element type T.

    Definition Classes
    WrappedCursorCursor
  11. def ensuring(cond: (WrappedCursor[T]) ⇒ Boolean, msg: ⇒ Any): WrappedCursor[T]

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def fold[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, T) ⇒ A)(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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 initial value

    maxDocs

    The maximum number of documents to be retrieved.

    suc

    the binary operator to be applied when the next document is successfully read.

    Definition Classes
    Cursor
  19. def foldBulks[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Iterator[T]) ⇒ State[A], err: ErrorHandler[A])(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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. 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
    WrappedCursorCursor
  20. def foldBulksM[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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. 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
    WrappedCursorCursor
  21. def foldResponses[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Response) ⇒ State[A], err: ErrorHandler[A])(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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. 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
    WrappedCursorCursor
  22. def foldResponsesM[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, Response) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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. 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
    WrappedCursorCursor
  23. def foldWhile[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, T) ⇒ State[A], err: ErrorHandler[A])(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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 initial value

    maxDocs

    The maximum number of documents to be retrieved.

    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.

    cursor.foldWhile(Nil: Seq[Person])((s, p) => Cursor.Cont(s :+ p),
      { (l, e) => println("last valid value: " + l); Cursor.Fail(e) })
    Definition Classes
    WrappedCursorCursor
  24. def foldWhileM[A](z: ⇒ A, maxDocs: Int = Int.MaxValue)(suc: (A, T) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ctx: ExecutionContext): Future[A]

    Permalink

    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 initial value

    maxDocs

    The maximum number of documents to be retrieved.

    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.

    cursor.foldWhileM(Nil: Seq[Person])(
      (s, p) => Future.successful(Cursor.Cont(s :+ p)),
      { (l, e) => Future {
        println("last valid value: " + l)
        Cursor.Fail(e)
      })
    Definition Classes
    WrappedCursorCursor
  25. def formatted(fmtstr: String): String

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  28. def headOption(implicit ctx: ExecutionContext): Future[Option[T]]

    Permalink

    Returns the first document matching the query, if any.

    Returns the first document matching the query, if any.

    Example:

    val cursor = collection.find(query, filter).cursor[BSONDocument]
    // return option of the first element.
    val first: Future[Option[BSONDocument]] = cursor.headOption
    Definition Classes
    Cursor
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def makeRequest(maxDocs: Int)(implicit ctx: ExecutionContext): Future[Response]

    Permalink

    Sends the initial request.

    Sends the initial request.

    Definition Classes
    WrappedCursorCursor
  31. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  32. def nextResponse(maxDocs: Int): (ExecutionContext, Response) ⇒ Future[Option[Response]]

    Permalink
    Definition Classes
    WrappedCursorCursor
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def [B](y: B): (WrappedCursor[T], B)

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

Deprecated Value Members

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

    Permalink

    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

    The maximum number of documents to be retrieved.

    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 Enumerator of documents.

    Definition Classes
    WrappedCursorCursor
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Use the Play Iteratee modules

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

    Permalink

    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. 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 Enumerator of Iterators of documents.

    Definition Classes
    WrappedCursorCursor
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Use the Play Iteratee modules

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

    Permalink

    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. 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 Enumerator of Responses.

    Definition Classes
    WrappedCursorCursor
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Use the Play Iteratee modules

  4. def rawEnumerateResponses(maxDocs: Int = Int.MaxValue)(implicit ctx: ExecutionContext): Enumerator[Response]

    Permalink

    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

    The maximum number of documents to be retrieved

    Definition Classes
    WrappedCursorCursor
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Use the Play Iteratee modules

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

    Permalink

    Returns the list of the matching documents.

    Returns the list of the matching documents.

    Definition Classes
    Cursor
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) consider using collect[List] instead

Inherited from Cursor[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped