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: Vault = Vault.empty) extends Message[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

io.chrisdavenport.vault.Vault 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, Message[F], Media[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Response
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Message
  7. Media
  8. AnyRef
  9. Any
  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: Vault = Vault.empty)

    status

    Status code and message

    headers

    Headers containing all response headers

    body

    EntityBody[F] representing the possible body of the response

    attributes

    io.chrisdavenport.vault.Vault 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 = SelfF[F]
    Definition Classes
    Message
  2. type SelfF[F0[_]] = Response[F0]
    Definition Classes
    Response → Message

Value Members

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

    Add a org.http4s.headers.Set-Cookie header with the provided values

  2. def addCookie(cookie: ResponseCookie): Self

    Add a Set-Cookie header for the provided ResponseCookie

  3. final def as[A](implicit F: MonadThrow[F], decoder: EntityDecoder[F, A]): F[A]

    Decode the Media to the specified type

    Decode the Media to the specified type

    If no valid Status has been described, allow Ok

    A

    type of the result

    decoder

    EntityDecoder used to decode the Media

    returns

    the effect which will generate the A

    Definition Classes
    Media
  4. final def attemptAs[T](implicit decoder: EntityDecoder[F, T]): DecodeResult[F, T]

    Decode the Media to the specified type

    Decode the Media to the specified type

    T

    type of the result

    decoder

    EntityDecoder used to decode the Media

    returns

    the effect which will generate the DecodeResult[T]

    Definition Classes
    Media
  5. val attributes: Vault
    Definition Classes
    Response → Message
  6. val body: EntityBody[F]
    Definition Classes
    Response → Message → Media
  7. final def bodyText(implicit RT: RaiseThrowable[F], defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Media
  8. final def charset: Option[Charset]
    Definition Classes
    Media
  9. final def contentLength: Option[Long]
    Definition Classes
    Media
  10. final def contentType: Option[Content-Type]
    Definition Classes
    Media
  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. def covary[F2[x] >: F[x]]: SelfF[F2]

    Lifts this Message's body to the specified effect type.

    Lifts this Message's body to the specified effect type.

    Definition Classes
    Message → Media
  13. def filterHeaders(f: (Header) ⇒ Boolean): Self

    Keep headers that satisfy the predicate

    Keep headers that satisfy the predicate

    f

    predicate

    returns

    a new message object which has only headers that satisfy the predicate

    Definition Classes
    Message
  14. val headers: Headers
    Definition Classes
    Response → Message → Media
  15. val httpVersion: HttpVersion
    Definition Classes
    Response → Message
  16. def isChunked: Boolean
    Definition Classes
    Message
  17. def mapK[G[_]](f: ~>[F, G]): Response[G]
  18. def putHeaders(headers: Header*): 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
    Message
  19. def removeCookie(name: String): Self

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

  20. def removeCookie(cookie: ResponseCookie): Self

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

  21. def removeHeader(key: HeaderKey): Self
    Definition Classes
    Message
  22. val status: Status
  23. def toString(): String
    Definition Classes
    Response → AnyRef → Any
  24. 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 F might not complete until the entire body has been consumed.

    Definition Classes
    Message
  25. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    Message
  26. def withAttribute[A](key: Key[A], value: A): Self

    Generates a new message object with the specified key/value pair appended to the #attributes.

    Generates a new message object with the specified key/value pair appended to the #attributes.

    A

    type of the value to store

    key

    io.chrisdavenport.vault.Key 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
  27. def withAttributes(attributes: Vault): Self
    Definition Classes
    Message
  28. 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
    Message
  29. def withContentType(contentType: Content-Type): Self
    Definition Classes
    Message
  30. def withContentTypeOption(contentTypeO: Option[Content-Type]): Self
    Definition Classes
    Message
  31. def withEmptyBody: 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
  32. 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
  33. def withHeaders(headers: Header*): Self
    Definition Classes
    Message
  34. def withHeaders(headers: Headers): Self
    Definition Classes
    Message
  35. def withHttpVersion(httpVersion: HttpVersion): Self
    Definition Classes
    Message
  36. def withStatus(status: Status): Self
  37. def withTrailerHeaders(trailerHeaders: F[Headers]): Self
    Definition Classes
    Message
  38. def withoutAttribute(key: Key[_]): Self

    Returns a new message object without the specified key in the #attributes.

    Returns a new message object without the specified key in the #attributes.

    key

    io.chrisdavenport.vault.Key to remove

    returns

    a new message object without the key

    Definition Classes
    Message
  39. def withoutContentType: Self
    Definition Classes
    Message
  40. def withoutTrailerHeaders: Self
    Definition Classes
    Message

Deprecated Value Members

  1. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Media
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.5) Can go into an infinite loop for charsets other than UTF-8. Replaced by bodyText

  2. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withHeaders instead

  3. def replaceAllHeaders(headers: Headers): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withHeaders instead

  4. 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

  5. def withType(t: MediaType)(implicit F: Functor[F]): Self
    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withContentType(Content-Type(t)) instead