PlayIterateesCursor

Abstract Value Members

abstract def bulkEnumerator(maxDocs: Int = Int.MaxValue, err: ErrorHandler[Unit] = FailOnError[Unit]())(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

Produces an Enumerator of Iterator of documents.
Produces an Enumerator of Iterator of documents.
maxDocs
Enumerate up to maxDocs documents.
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. Only the errors when reading the inputs from the DB will be handle: if then an Iteratee is failing to process, the error is out of this mechanism scope.
returns
an Enumerator of Iterators of documents.
abstract def collect[M[_]](maxDocs: Int, err: ErrorHandler[M[T]])(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

Definition Classes
CursorCompatAPI
abstract def enumerator(maxDocs: Int = Int.MaxValue, err: ErrorHandler[Unit] = FailOnError[Unit]())(implicit ctx: ExecutionContext): Enumerator[T]

Produces an Enumerator of documents.
Produces an Enumerator of documents.
maxDocs
Enumerate up to maxDocs documents.
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. Only the errors when reading the inputs from the DB will be handle: if then an Iteratee is failing to process, the error is out of this mechanism scope.
returns
an Enumerator of documents.
abstract def foldBulks[A](z: ⇒ A, maxDocs: Int)(suc: (A, Iterator[T]) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
abstract def foldBulksM[A](z: ⇒ A, maxDocs: Int)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
abstract def foldWhile[A](z: ⇒ A, maxDocs: Int)(suc: (A, T) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
abstract def foldWhileM[A](z: ⇒ A, maxDocs: Int)(suc: (A, T) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
abstract def head(implicit ec: ExecutionContext): Future[T]

Definition Classes
Cursor
abstract def headOption(implicit ec: ExecutionContext): Future[Option[T]]

Definition Classes
Cursor
abstract def foldResponses[A](z: ⇒ A, maxDocs: Int)(suc: (A, Response) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
Annotations
@deprecated
Deprecated
(Since version 0.19.4) Internal: will be made private
abstract def foldResponsesM[A](z: ⇒ A, maxDocs: Int)(suc: (A, Response) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
Annotations
@deprecated
Deprecated
(Since version 0.19.4) Internal: will be made private
abstract def responseEnumerator(maxDocs: Int = Int.MaxValue, err: ErrorHandler[Unit] = FailOnError[Unit]())(implicit ctx: ExecutionContext): Enumerator[Response]

Annotations
@deprecated
Deprecated
(Since version 0.19.4) Will be removed

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

Implicit information
This member is added by an implicit conversion from PlayIterateesCursor[T] to ArrowAssoc[PlayIterateesCursor[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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (PlayIterateesCursor[T]) ⇒ Boolean, msg: ⇒ Any): PlayIterateesCursor[T]

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

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

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

Implicit information
This member is added by an implicit conversion from PlayIterateesCursor[T] to Ensuring[PlayIterateesCursor[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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fold[A](z: ⇒ A, maxDocs: Int)(suc: (A, T) ⇒ A)(implicit ec: ExecutionContext): Future[A]

Definition Classes
Cursor
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
def →[B](y: B): (PlayIterateesCursor[T], B)

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

Inherited from Cursor[T]

Inherited from CursorCompatAPI[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped

Related Doc: package iteratees

sealed trait PlayIterateesCursor[T] extends Cursor[T]

Abstract Value Members

abstract def bulkEnumerator(maxDocs: Int = Int.MaxValue, err: ErrorHandler[Unit] = FailOnError[Unit]())(implicit ctx: ExecutionContext): Enumerator[Iterator[T]]

abstract def collect[M[_]](maxDocs: Int, err: ErrorHandler[M[T]])(implicit cbf: CanBuildFrom[M[_], T, M[T]], ec: ExecutionContext): Future[M[T]]

abstract def enumerator(maxDocs: Int = Int.MaxValue, err: ErrorHandler[Unit] = FailOnError[Unit]())(implicit ctx: ExecutionContext): Enumerator[T]

abstract def foldBulks[A](z: ⇒ A, maxDocs: Int)(suc: (A, Iterator[T]) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

abstract def foldBulksM[A](z: ⇒ A, maxDocs: Int)(suc: (A, Iterator[T]) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

abstract def foldWhile[A](z: ⇒ A, maxDocs: Int)(suc: (A, T) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

abstract def foldWhileM[A](z: ⇒ A, maxDocs: Int)(suc: (A, T) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

abstract def head(implicit ec: ExecutionContext): Future[T]

abstract def headOption(implicit ec: ExecutionContext): Future[Option[T]]

abstract def foldResponses[A](z: ⇒ A, maxDocs: Int)(suc: (A, Response) ⇒ State[A], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

abstract def foldResponsesM[A](z: ⇒ A, maxDocs: Int)(suc: (A, Response) ⇒ Future[State[A]], err: ErrorHandler[A])(implicit ec: ExecutionContext): Future[A]

abstract def responseEnumerator(maxDocs: Int = Int.MaxValue, err: ErrorHandler[Unit] = FailOnError[Unit]())(implicit ctx: ExecutionContext): Enumerator[Response]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (PlayIterateesCursor[T], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (PlayIterateesCursor[T]) ⇒ Boolean, msg: ⇒ Any): PlayIterateesCursor[T]

def ensuring(cond: (PlayIterateesCursor[T]) ⇒ Boolean): PlayIterateesCursor[T]

def ensuring(cond: Boolean, msg: ⇒ Any): PlayIterateesCursor[T]

def ensuring(cond: Boolean): PlayIterateesCursor[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fold[A](z: ⇒ A, maxDocs: Int)(suc: (A, T) ⇒ A)(implicit ec: ExecutionContext): Future[A]

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (PlayIterateesCursor[T], B)

Inherited from Cursor[T]

Inherited from CursorCompatAPI[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped