Packages

final case class Response[F[_]](status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.`HTTP/1.1`, headers: Headers = Headers.empty, body: EntityBody[F] = EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message[F] with ResponseOps[F] 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

EntityBody[F] 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

Source
Message.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ResponseOps[F], Message[F], MessageOps[F], 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
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 Response(status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.`HTTP/1.1`, headers: Headers = Headers.empty, body: EntityBody[F] = EmptyBody, attributes: AttributeMap = AttributeMap.empty)

    status

    Status code and message

    headers

    Headers containing all response headers

    body

    EntityBody[F] 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[F]
    Definition Classes
    Response → Message → MessageOps

Value Members

  1. final def addCookie(name: String, content: String, expires: Option[HttpDate] = None)(implicit F: Functor[F]): Self

    Add a Set-Cookie header with the provided values

    Add a Set-Cookie header with the provided values

    Definition Classes
    ResponseOps
  2. final def addCookie(cookie: ResponseCookie)(implicit F: Functor[F]): Self

    Add a Set-Cookie header for the provided Cookie

    Add a Set-Cookie header for the provided Cookie

    Definition Classes
    ResponseOps
  3. final def as[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): F[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 effect which will generate the T

    Definition Classes
    MessageOps
  4. def attemptAs[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): DecodeResult[F, 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 effect which will generate the DecodeResult[T]

    Definition Classes
    Message → MessageOps
  5. val attributes: AttributeMap
    Definition Classes
    Response → Message
  6. val body: EntityBody[F]
    Definition Classes
    Response → Message
  7. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Message
  8. 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
  9. def contentLength: Option[Long]
    Definition Classes
    Message
  10. def contentType: Option[Content-Type]
    Definition Classes
    Message
  11. def cookies: List[ResponseCookie]

    Returns a list of cookies from the org.http4s.headers.Set-Cookie headers.

    Returns a list of cookies from the org.http4s.headers.Set-Cookie headers. Includes expired cookies, such as those that represent cookie deletion.

  12. final def filterHeaders(f: (Header) ⇒ Boolean)(implicit F: Functor[F]): 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
    MessageOps
  13. val headers: Headers
    Definition Classes
    Response → Message
  14. val httpVersion: HttpVersion
    Definition Classes
    Response → Message
  15. def isChunked: Boolean
    Definition Classes
    Message
  16. def mapK[G[_]](f: ~>[F, G]): Response[G]
  17. final def putHeaders(headers: Header*)(implicit F: Functor[F]): Self

    Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.

    Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.

    Definition Classes
    MessageOps
  18. final def removeCookie(name: String)(implicit F: Functor[F]): Self

    Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client

    Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client

    Definition Classes
    ResponseOps
  19. final def removeCookie(cookie: ResponseCookie)(implicit F: Functor[F]): Self

    Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client

    Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client

    Definition Classes
    ResponseOps
  20. final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  21. final def replaceAllHeaders(headers: Header*)(implicit F: Functor[F]): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  22. final def replaceAllHeaders(headers: Headers)(implicit F: Functor[F]): 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
  23. val status: Status
  24. def toString(): String
    Definition Classes
    Response → AnyRef → Any
  25. def trailerHeaders(implicit F: Applicative[F]): F[Headers]

    The trailer headers, as specified in Section 3.6.1 of RFC 2616.

    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
  26. def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self
    Definition Classes
    Message → MessageOps
  27. def withAttribute[A](key: AttributeKey[A], value: A)(implicit F: Functor[F]): 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
    Message → MessageOps
  28. def withAttribute[V](entry: AttributeEntry[V])(implicit F: Functor[F]): 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
  29. def withBodyStream(body: EntityBody[F]): Self

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length.

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length. Most use cases are better served by withEntity, which uses an EntityEncoder to maintain the headers.

    Definition Classes
    Response → Message
  30. final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  31. final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  32. def withEmptyBody(implicit F: Functor[F]): Self

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

    Definition Classes
    Message
  33. def withEntity[T](b: T)(implicit w: EntityEncoder[F, T]): 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
  34. def withStatus(status: Status)(implicit F: Functor[F]): Self

    Change the status of this response object

    Change the status of this response object

    status

    value to replace on the response object

    returns

    a new response object with the new status code

    Definition Classes
    Response → ResponseOps
  35. final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  36. final def withType(t: MediaType)(implicit F: Functor[F]): Self

    Added the org.http4s.headers.Content-Type header to the response

    Added the org.http4s.headers.Content-Type header to the response

    Definition Classes
    MessageOps
  37. final def withoutContentType(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps

Deprecated Value Members

  1. def withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): F[Self]
    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19) Use withEntity