reactivemongo.api

TailableCursor

class TailableCursor[T] extends Cursor[T]

Linear Supertypes
Cursor[T], AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TailableCursor
  2. Cursor
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TailableCursor(cursor: DefaultCursor[T], controller: TailableController = new TailableController())(implicit ctx: ExecutionContext)

Value Members

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

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def close(): Unit

    Explicitly closes that cursor.

    Explicitly closes that cursor. It cannot be used again.

    Definition Classes
    TailableCursorCursor
  11. def collect[M[_]](upTo: Int)(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]. The reuse of this cursor may cause unexpected behavior.

    Example:

    val cursor2 = collection.find(query, filter).cursor
    // gather the first 3 documents
    val futureList = cursor.collect[List](3)
    M

    the type of the returned collection.

    upTo

    The maximum size of this collection.

    Definition Classes
    Cursor
  12. def collect[M[_]]()(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]. The reuse of this cursor may cause unexpected behavior.

    Example:

    val cursor2 = collection.find(query, filter).cursor
    val futureList = cursor.toList
    futureList.map { list =>
      list.foreach { doc =>
        println("found document: " + BSONDocument.pretty(doc))
      }
    }
    M

    the type of the returned collection.

    Definition Classes
    Cursor
  13. def connection: Future[MongoConnection]

    Definition Classes
    TailableCursorCursor
  14. def cursorId: Future[Long]

    Definition Classes
    TailableCursorCursor
  15. def ensuring(cond: (TailableCursor[T]) ⇒ Boolean, msg: ⇒ Any): TailableCursor[T]

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

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

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

    Implicit information
    This member is added by an implicit conversion from TailableCursor[T] to Ensuring[TailableCursor[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def enumerate(upTo: Int)(implicit ctx: ExecutionContext): Enumerator[T]

    Definition Classes
    Cursor
  20. def enumerate()(implicit ctx: ExecutionContext): Enumerator[T]

    Enumerates this cursor.

    Enumerates this cursor. The reuse of this cursor may cause unexpected behavior.

    Example:

    // Get a cursor of BSONDocuments
    val cursor = collection.find(query, filter).cursor
    // Let's enumerate this cursor and print a readable representation of each document in the response
    cursor.enumerate.apply(Iteratee.foreach { doc =>
      println("found document: " + BSONDocument.pretty(doc))
    })

    It is worth diving into the Play! 2.0 Iteratee documentation.

    Definition Classes
    Cursor
  21. def enumerateBulks(limit: Int)(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

    Bulk enumerator.

    Bulk enumerator. The reuse of this cursor may cause unexpected behavior.

    Much faster when dealing with large collections.

    limit

    Stop enumerating when at least limit documents have been received.

    Definition Classes
    Cursor
  22. def enumerateBulks()(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

    Bulk enumerator.

    Bulk enumerator. The reuse of this cursor may cause unexpected behavior.

    Much faster when dealing with large collections.

    Definition Classes
    Cursor
  23. def enumerateCursor()(implicit ctx: ExecutionContext): Enumerator[Cursor[T]]

    Cursor enumerator.

    Cursor enumerator. The reuse of this cursor may cause unexpected behavior.

    Low-level API, consider enumerate() or enumerateBulks() instead.

    Definition Classes
    Cursor
  24. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. def formatted(fmtstr: String): String

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

    Definition Classes
    AnyRef → Any
  29. def hasNext: Boolean

    Tells if another instance of cursor can be fetched.

    Tells if another instance of cursor can be fetched.

    Definition Classes
    TailableCursorCursor
  30. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  31. def headOption()(implicit ec: ExecutionContext): Future[Option[T]]

    Gets the first returned document, if any.

    Gets the first returned document, if any.

    Example:

    val cursor2 = collection.find(query, filter).cursor
    val maybeOneDoc = cursor2.headOption
    Definition Classes
    Cursor
  32. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  33. val iterator: Iterator[T]

    An iterator on the last fetched documents.

    An iterator on the last fetched documents.

    Definition Classes
    TailableCursorCursor
  34. def nDocs: Int

    Definition Classes
    TailableCursorCursor
  35. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  36. def next: Future[Cursor[T]]

    Gets the next instance of that cursor.

    Gets the next instance of that cursor.

    Definition Classes
    TailableCursorCursor
  37. final def notify(): Unit

    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  39. def offset: None.type

    Definition Classes
    TailableCursorCursor
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  41. def toList(upTo: Int)(implicit ctx: ExecutionContext): Future[List[T]]

    Collects all the documents into a collection of type M[T].

    Collects all the documents into a collection of type M[T]. The reuse of this cursor may cause unexpected behavior.

    Example:

    val cursor2 = collection.find(query, filter).cursor
    // return the 3 first documents in a list.
    val list = cursor2.toList(3)
    Definition Classes
    Cursor
  42. def toList()(implicit ctx: ExecutionContext): Future[List[T]]

    Collects all the documents into a collection of type M[T].

    Collects all the documents into a collection of type M[T]. The reuse of this cursor may cause unexpected behavior.

    Example:

    val cursor2 = collection.find(query, filter).cursor
    val list = cursor2.toList
    Definition Classes
    Cursor
  43. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  47. def [B](y: B): (TailableCursor[T], B)

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

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from TailableCursor[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:
    (tailableCursor: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from TailableCursor[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:
    (tailableCursor: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: TailableCursor[T]

    Implicit information
    This member is added by an implicit conversion from TailableCursor[T] to ArrowAssoc[TailableCursor[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:
    (tailableCursor: ArrowAssoc[TailableCursor[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: TailableCursor[T]

    Implicit information
    This member is added by an implicit conversion from TailableCursor[T] to Ensuring[TailableCursor[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:
    (tailableCursor: Ensuring[TailableCursor[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Cursor[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped