t

reactivemongo.api

WrappedCursor

trait WrappedCursor[T] extends Cursor[T] with WrappedCursorCompat[T]

Cursor wrapper, to help to define custom cursor classes.

See also

CursorProducer

Linear Supertypes
WrappedCursorCompat[T], Cursor[T], CursorCompatAPI[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WrappedCursor
  2. WrappedCursorCompat
  3. Cursor
  4. CursorCompatAPI
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def wrappee: Cursor[T]

    The underlying cursor

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 WrappedCursor[T] toany2stringadd[WrappedCursor[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WrappedCursor[T], B)
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toArrowAssoc[WrappedCursor[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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def collect[M[_]](maxDocs: Int, err: ErrorHandler[M[T]])(implicit cbf: Factory[T, M[T]], ec: ExecutionContext): Future[M[T]]
    Definition Classes
    WrappedCursorCompat
  9. def ensuring(cond: (WrappedCursor[T]) => Boolean, msg: => Any): WrappedCursor[T]
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toEnsuring[WrappedCursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (WrappedCursor[T]) => Boolean): WrappedCursor[T]
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toEnsuring[WrappedCursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): WrappedCursor[T]
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toEnsuring[WrappedCursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): WrappedCursor[T]
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toEnsuring[WrappedCursor[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. 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
  16. 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
    WrappedCursorCursor
  17. 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
    WrappedCursorCursor
  18. def foldResponses[A](z: => A, maxDocs: Int = -1)(suc: (A, Response) => State[A], err: ErrorHandler[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.

    Definition Classes
    WrappedCursorCursor
  19. def foldResponsesM[A](z: => A, maxDocs: Int = -1)(suc: (A, Response) => Future[State[A]], err: ErrorHandler[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.

    Definition Classes
    WrappedCursorCursor
  20. 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
    WrappedCursorCursor
  21. 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
    WrappedCursorCursor
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toStringFormat[WrappedCursor[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. 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.bson.BSONDocument
    import reactivemongo.api.collections.bson.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
    WrappedCursorCursor
  26. 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
    WrappedCursorCursor
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (WrappedCursor[T], B)
    Implicit
    This member is added by an implicit conversion from WrappedCursor[T] toArrowAssoc[WrappedCursor[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from WrappedCursorCompat[T]

Inherited from Cursor[T]

Inherited from CursorCompatAPI[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped