play.api.mvc

ChunkedResult

case class ChunkedResult[A](header: ResponseHeader, chunks: Function1[Iteratee[A, Unit], _])(implicit writeable: Writeable[A]) extends PlainResult with Product with Serializable

A chunked result, which defines the response header and a chunks enumerator to send asynchronously to the client.

A

the response body content type.

header

the response header, which contains status code and HTTP headers

chunks

the chunks enumerator

Source
Results.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, PlainResult, Result, WithHeaders[PlainResult], NotNull, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ChunkedResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PlainResult
  7. Result
  8. WithHeaders
  9. NotNull
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChunkedResult(header: ResponseHeader, chunks: Function1[Iteratee[A, Unit], _])(implicit writeable: Writeable[A])

    header

    the response header, which contains status code and HTTP headers

    chunks

    the chunks enumerator

Type Members

  1. type BODY_CONTENT = A

    The body content type.

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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. def as(contentType: String): PlainResult

    Changes the result content type.

    Changes the result content type.

    For example:

    Ok("Hello world").as("text/xml")
    contentType

    the new content type.

    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. val chunks: Function1[Iteratee[A, Unit], _]

    the chunks enumerator

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def discardingCookies(cookies: DiscardingCookie*): PlainResult

    Discards cookies along this result.

    Discards cookies along this result.

    For example:

    Ok("Hello world").discardingCookies("theme")
    cookies

    the cookies to discard along to this result

    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. def flashing(values: (String, String)*): PlainResult

    Adds values to the flash scope for this result.

    Adds values to the flash scope for this result.

    For example:

    Ok("Hello world").flashing("success" -> "Done!")
    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  14. def flashing(flash: Flash): PlainResult

    Adds values to the flash scope for this result.

    Adds values to the flash scope for this result.

    For example:

    Ok("Hello world").flashing(flash + ("success" -> "Done!"))
    flash

    the flash scope to set with this result

    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. val header: ResponseHeader

    the response header, which contains status code and HTTP headers

    the response header, which contains status code and HTTP headers

    Definition Classes
    ChunkedResultPlainResult
  17. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  19. final def notify(): Unit

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

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

    Definition Classes
    AnyRef
  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  25. def withCookies(cookies: Cookie*): PlainResult

    Adds cookies to this result.

    Adds cookies to this result.

    For example:

    Ok("Hello world").withCookies(Cookie("theme", "blue"))
    cookies

    the cookies to add to this result

    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  26. def withHeaders(headers: (String, String)*): ChunkedResult[A]

    Adds headers to this result.

    Adds headers to this result.

    For example:

    Ok("Hello world").withHeaders(ETAG -> "0")
    headers

    the headers to add to this result.

    returns

    the new result

    Definition Classes
    ChunkedResultWithHeaders
  27. def withLang(lang: Lang)(implicit app: Application): PlainResult

    Sets the users language permanently for future requests by storing it in a cookie.

    Sets the users language permanently for future requests by storing it in a cookie.

    For example:

    implicit val lang = Lang("fr-FR")
    Ok(Messages("hello.world")).withLang(lang)
    lang

    the language to store for the user

    returns

    the new result

    Definition Classes
    WithHeaders
  28. def withNewSession: PlainResult

    Discards the existing session for this result.

    Discards the existing session for this result.

    For example:

    Ok("Hello world").withNewSession
    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  29. def withSession(session: (String, String)*): PlainResult

    Sets a new session for this result, discarding the existing session.

    Sets a new session for this result, discarding the existing session.

    For example:

    Ok("Hello world").withSession("saidHello" -> "yes")
    session

    the session to set with this result

    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  30. def withSession(session: Session): PlainResult

    Sets a new session for this result.

    Sets a new session for this result.

    For example:

    Ok("Hello world").withSession(session + ("saidHello" -> "true"))
    session

    the session to set with this result

    returns

    the new result

    Definition Classes
    PlainResultWithHeaders
  31. implicit val writeable: Writeable[A]

Deprecated Value Members

  1. def discardingCookies(name: String, names: String*): PlainResult

    Discards cookies along this result.

    Discards cookies along this result.

    For example:

    Ok("Hello world").discardingCookies("theme")
    names

    the names of the cookies to discard along to this result

    returns

    the new result

    Definition Classes
    WithHeaders
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1) This method can only discard cookies on the / path with no domain and without secure set. Use discardingCookies(DiscardingCookie*) instead.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PlainResult

Inherited from Result

Inherited from WithHeaders[PlainResult]

Inherited from NotNull

Inherited from AnyRef

Inherited from Any

Ungrouped