Class

reactivemongo.api.commands.AggregationFramework

AggregationResult

Related Doc: package AggregationFramework

Permalink

case class AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = None) extends Product with Serializable

firstBatch

the documents of the first batch

cursor

the cursor from the result, if any

See also

Cursor

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregationResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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

Instance Constructors

  1. new AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = None)

    Permalink

    firstBatch

    the documents of the first batch

    cursor

    the cursor from the result, if any

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 AggregationResult to any2stringadd[AggregationResult] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AggregationResult, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from AggregationResult to ArrowAssoc[AggregationResult] 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. val cursor: Option[ResultCursor]

    Permalink

    the cursor from the result, if any

  9. def ensuring(cond: (AggregationResult) ⇒ Boolean, msg: ⇒ Any): AggregationResult

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. val firstBatch: List[P.Document]

    Permalink

    the documents of the first batch

  16. def formatted(fmtstr: String): String

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def head[T](implicit reader: P.Reader[T]): List[T]

    Permalink

    Returns the first batch as a list, using the given reader.

  19. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (AggregationResult, B)

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

Deprecated Value Members

  1. def documents: List[P.Document]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Use firstBatch

  2. def result[T](implicit reader: P.Reader[T]): List[T]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.10) Use head

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AggregationResult to any2stringadd[AggregationResult]

Inherited by implicit conversion StringFormat from AggregationResult to StringFormat[AggregationResult]

Inherited by implicit conversion Ensuring from AggregationResult to Ensuring[AggregationResult]

Inherited by implicit conversion ArrowAssoc from AggregationResult to ArrowAssoc[AggregationResult]

Ungrouped