Class

play.api.libs.ws.ahc

StreamedResponse

Related Doc: package ahc

Permalink

class StreamedResponse extends StandaloneWSResponse with CookieBuilder

A streamed response containing a response header and a streamable body.

Note that this is only usable with a stream call, i.e.

class MyClass extends StreamedBodyReadable {
  ws.url("http://example.com").stream().map { response =>
     val source = response.body[Source[ByteString, NotUsed]]
     ...
  }
}
Linear Supertypes
CookieBuilder, WSCookieConverter, StandaloneWSResponse, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamedResponse
  2. CookieBuilder
  3. WSCookieConverter
  4. StandaloneWSResponse
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StreamedResponse(client: StandaloneAhcWSClient, status: Int, statusText: String, uri: URI, headers: Map[String, Seq[String]], publisher: Publisher[HttpResponseBodyPart])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def asCookie(c: Cookie): WSCookie

    Permalink
    Definition Classes
    WSCookieConverter

  5. def asCookie(cookie: WSCookie): Cookie

    Permalink
    Definition Classes
    WSCookieConverter

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def body[T](implicit arg0: BodyReadable[T]): T

    Permalink
    Definition Classes
    StandaloneWSResponse

  8. lazy val body: String

    Permalink
    Definition Classes
    StreamedResponse → StandaloneWSResponse

  9. lazy val bodyAsBytes: ByteString

    Permalink

    THIS IS A BLOCKING OPERATION.

    THIS IS A BLOCKING OPERATION. It should not be used in production.

    Note that this is not a charset aware operation, as the stream does not have access to the underlying machinery that disambiguates responses.

    returns

    a UTF-8 string constructed from the bytestring.

    Definition Classes
    StreamedResponse → StandaloneWSResponse

  10. lazy val bodyAsSource: Source[ByteString, _]

    Permalink
    Definition Classes
    StreamedResponse → StandaloneWSResponse

  11. def buildCookies(headers: Map[String, Seq[String]]): Seq[WSCookie]

    Permalink
    Definition Classes
    CookieBuilder

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. def contentType: String

    Permalink
    Definition Classes
    StandaloneWSResponse

  14. def cookie(name: String): Option[WSCookie]

    Permalink

    Get only one cookie, using the cookie name.

    Get only one cookie, using the cookie name.

    Definition Classes
    StreamedResponse → StandaloneWSResponse

  15. lazy val cookies: Seq[WSCookie]

    Permalink

    Get all the cookies.

    Get all the cookies.

    Definition Classes
    StreamedResponse → StandaloneWSResponse

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. def header(name: String): Option[String]

    Permalink
    Definition Classes
    StandaloneWSResponse

  22. def headerValues(name: String): Seq[String]

    Permalink
    Definition Classes
    StandaloneWSResponse

  23. val headers: Map[String, Seq[String]]

    Permalink
    Definition Classes
    StreamedResponse → StandaloneWSResponse

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. val status: Int

    Permalink
    Definition Classes
    StreamedResponse → StandaloneWSResponse

  29. val statusText: String

    Permalink
    Definition Classes
    StreamedResponse → StandaloneWSResponse

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

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  32. def underlying[T]: T

    Permalink

    Get the underlying response object.

    Get the underlying response object.

    Definition Classes
    StreamedResponse → StandaloneWSResponse

  33. val uri: URI

    Permalink

  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CookieBuilder

Inherited from WSCookieConverter

Inherited from StandaloneWSResponse

Inherited from AnyRef

Inherited from Any

Ungrouped