org.http4s

Response

case class Response(status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message with ResponseOps with Product with Serializable

Representation of the HTTP response to send back to the client

status

Status code and message

headers

Headers containing all response headers

body

scalaz.stream.Process[Task,Chunk] representing the possible body of the response

attributes

AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

Linear Supertypes
Serializable, Serializable, Product, Equals, ResponseOps, Message, MessageOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Response
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ResponseOps
  7. Message
  8. MessageOps
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Response(status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty)

    status

    Status code and message

    headers

    Headers containing all response headers

    body

    scalaz.stream.Process[Task,Chunk] representing the possible body of the response

    attributes

    AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

Type Members

  1. type Self = Response

    Definition Classes
    ResponseMessageMessageOps

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 addCookie(name: String, content: String, expires: Option[Instant] = None): Self

    Add a Set-Cookie header with the provided values

    Add a Set-Cookie header with the provided values

    Definition Classes
    ResponseOps
  7. def addCookie(cookie: Cookie): Self

    Add a Set-Cookie header for the provided Cookie

    Add a Set-Cookie header for the provided Cookie

    Definition Classes
    ResponseOps
  8. def as[T](implicit decoder: EntityDecoder[T]): Task[T]

    Decode the Message to the specified type

    Decode the Message to the specified type

    If no valid Status has been described, allow Ok

    T

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the Task which will generate the T

    Definition Classes
    MessageOps
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[T]

    Decode the Message to the specified type

    Decode the Message to the specified type

    T

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the Task which will generate the DecodeResult[T]

    Definition Classes
    MessageMessageOps
  11. val attributes: AttributeMap

    AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.

    AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

    Definition Classes
    ResponseMessage
  12. val body: EntityBody

    scalaz.

    scalaz.stream.Process[Task,Chunk] representing the possible body of the response

    Definition Classes
    ResponseMessage
  13. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

    Definition Classes
    Message
  14. def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self

    Attributes
    protected
    Definition Classes
    ResponseMessage
  15. def charset: Option[Charset]

    Returns the charset parameter of the Content-Type header, if present.

    Returns the charset parameter of the Content-Type header, if present. Does not introspect the body for media types that define a charset internally.

    Definition Classes
    Message
  16. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def contentLength: Option[Int]

    Definition Classes
    Message
  18. def contentType: Option[Content-Type]

    Definition Classes
    Message
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def filterHeaders(f: (Header) ⇒ Boolean): Self

    Remove headers that satisfy the predicate

    Remove headers that satisfy the predicate

    f

    predicate

    returns

    a new message object which lacks the specified headers

    Definition Classes
    MessageMessageOps
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. val headers: Headers

    Headers containing all response headers

    Headers containing all response headers

    Definition Classes
    ResponseMessage
  24. val httpVersion: HttpVersion

    Definition Classes
    ResponseMessage
  25. def isChunked: Boolean

    Definition Classes
    Message
  26. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  30. def putHeaders(headers: Header*): Self

    Add the provided headers to the existing headers, replacing those of the same header name

    Add the provided headers to the existing headers, replacing those of the same header name

    Definition Classes
    MessageMessageOps
  31. def removeCookie(name: String): Self

    Add a Set-Cookie which will remove the specified cookie from the client

    Add a Set-Cookie which will remove the specified cookie from the client

    Definition Classes
    ResponseOps
  32. def removeCookie(cookie: Cookie): Self

    Add a `Set-Cookie` which will remove the specified cookie from the client

    Add a `Set-Cookie` which will remove the specified cookie from the client

    Definition Classes
    ResponseOps
  33. def removeHeader(key: HeaderKey): Self

    Definition Classes
    MessageOps
  34. def replaceAllHeaders(headers: Headers): Self

    Replaces the Headers of the incoming Request object

    Replaces the Headers of the incoming Request object

    headers

    Headers containing the desired headers

    returns

    a new Request object

    Definition Classes
    MessageMessageOps
  35. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  36. val status: Status

    Status code and message

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

    Definition Classes
    AnyRef
  38. def toString(): String

    Definition Classes
    Response → AnyRef → Any
  39. def trailerHeaders: Task[Headers]

    The trailer headers, as specified in Section 3.

    The trailer headers, as specified in Section 3.6.1 of RFC 2616. The resulting task might not complete unless the entire body has been consumed.

    Definition Classes
    Message
  40. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def withAttribute[A](key: AttributeKey[A], value: A): Self

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    A

    type of the value to store

    key

    AttributeKey with which to associate the value

    value

    value associated with the key

    returns

    a new message object with the key/value pair appended

    Definition Classes
    MessageMessageOps
  44. def withAttribute[V](entry: AttributeEntry[V]): Self

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    Generates a new message object with the specified key/value pair appended to the org.http4s.AttributeMap

    V

    type of the value to store

    entry

    AttributeEntry entry to add

    returns

    a new message object with the key/value pair appended

    Definition Classes
    MessageOps
  45. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[Self]

    Replace the body of this message with a new body

    Replace the body of this message with a new body

    T

    type of the Body

    b

    body to attach to this method

    w

    EntityEncoder with which to convert the body to an EntityBody

    returns

    a new message with the new body

    Definition Classes
    Message
  46. def withContentType(contentType: Option[Content-Type]): Self

    Definition Classes
    MessageOps
  47. def withStatus[S](status: S)(implicit arg0: (S) ⇒ Status): Self

    Response specific extension methods

    Response specific extension methods

    S

    type that can be converted to a Status

    status

    value to replace on the response object

    returns

    a new response object with the new status code

    Definition Classes
    ResponseResponseOps
  48. def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Definition Classes
    MessageOps
  49. def withType(t: MediaType): Self

    Added the `Content-Type` header to the response

    Added the `Content-Type` header to the response

    Definition Classes
    MessageOps

Deprecated Value Members

  1. final def withHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

  2. final def withHeaders(headers: Headers): Self

    Replaces the Headers of the incoming Request object

    Replaces the Headers of the incoming Request object

    headers

    Headers containing the desired headers

    returns

    a new Request object

    Definition Classes
    MessageOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ResponseOps

Inherited from Message

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

Ungrouped