Class/Object

org.http4s

Response

Related Docs: object Response | package http4s

Permalink

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

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

    Permalink

    status

    Status code and message

    headers

    Headers containing all response headers

    body

    EntityBody[F] representing the possible body of the response

    attributes

    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 = Response[F]

    Permalink
    Definition Classes
    ResponseMessage

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

    Permalink

    Add a `Set-Cookie` header with the provided values

  5. def addCookie(cookie: ResponseCookie): Self

    Permalink

    Add a Set-Cookie header for the provided ResponseCookie

  6. def as[A](implicit F: MonadError[F, Throwable], decoder: EntityDecoder[F, A]): F[A]

    Permalink

    Decode the Message to the specified type

    Decode the Message to the specified type

    If no valid Status has been described, allow Ok

    A

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the effect which will generate the A

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

    Permalink
    Definition Classes
    Any
  8. def attemptAs[T](implicit decoder: EntityDecoder[F, T]): DecodeResult[F, T]

    Permalink

    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
  9. val attributes: Vault

    Permalink

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

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

    Definition Classes
    ResponseMessage
  10. val body: EntityBody[F]

    Permalink

    EntityBody[F] representing the possible body of the response

    EntityBody[F] representing the possible body of the response

    Definition Classes
    ResponseMessage
  11. def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]

    Permalink
    Definition Classes
    Message
  12. def change(httpVersion: HttpVersion, body: EntityBody[F], headers: Headers, attributes: Vault): Self

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

    Permalink

    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
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def contentLength: Option[Long]

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

    Permalink
    Definition Classes
    Message
  17. def cookies: List[ResponseCookie]

    Permalink

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

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

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

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

    Permalink

    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
  20. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. val headers: Headers

    Permalink

    Headers containing all response headers

    Headers containing all response headers

    Definition Classes
    ResponseMessage
  23. val httpVersion: HttpVersion

    Permalink
    Definition Classes
    ResponseMessage
  24. def isChunked: Boolean

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

    Permalink
    Definition Classes
    Any
  26. def mapK[G[_]](f: ~>[F, G]): Response[G]

    Permalink
  27. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    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
  31. def removeCookie(name: String): Self

    Permalink

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

  32. def removeCookie(cookie: ResponseCookie): Self

    Permalink

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

  33. def removeHeader(key: HeaderKey): Self

    Permalink
    Definition Classes
    Message
  34. val status: Status

    Permalink

    Status code and message

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

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

    Permalink
    Definition Classes
    Response → AnyRef → Any
  37. def trailerHeaders(implicit F: Applicative[F]): F[Headers]

    Permalink

    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
  38. def transformHeaders(f: (Headers) ⇒ Headers): Self

    Permalink
    Definition Classes
    Message
  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def withAttribute[A](key: Key[A], value: A): Self

    Permalink

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

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

    A

    type of the value to store

    key

    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
  43. def withAttributes(attributes: Vault): Self

    Permalink
    Definition Classes
    Message
  44. def withBodyStream(body: EntityBody[F]): Self

    Permalink

    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
  45. def withContentType(contentType: Content-Type): Self

    Permalink
    Definition Classes
    Message
  46. def withContentTypeOption(contentTypeO: Option[Content-Type]): Self

    Permalink
    Definition Classes
    Message
  47. def withEmptyBody: Self

    Permalink

    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
  48. def withEntity[T](b: T)(implicit w: EntityEncoder[F, T]): Self

    Permalink

    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
  49. def withHeaders(headers: Header*): Self

    Permalink
    Definition Classes
    Message
  50. def withHeaders(headers: Headers): Self

    Permalink
    Definition Classes
    Message
  51. def withHttpVersion(httpVersion: HttpVersion): Self

    Permalink
    Definition Classes
    Message
  52. def withStatus(status: Status): Self

    Permalink
  53. def withTrailerHeaders(trailerHeaders: F[Headers]): Self

    Permalink
    Definition Classes
    Message
  54. def withoutAttribute(key: Key[_]): Self

    Permalink

    Returns a new message object without the specified key in the AttributeMap

    Returns a new message object without the specified key in the AttributeMap

    key

    Key to remove

    returns

    a new message object without the key

    Definition Classes
    Message
  55. def withoutContentType: Self

    Permalink
    Definition Classes
    Message
  56. def withoutTrailerHeaders: Self

    Permalink
    Definition Classes
    Message

Deprecated Value Members

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

    Permalink

    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

  2. def replaceAllHeaders(headers: Headers): Self

    Permalink

    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 withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): F[Self]

    Permalink
    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19) Use withEntity

  4. def withType(t: MediaType)(implicit F: Functor[F]): Self

    Permalink
    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Message[F]

Inherited from AnyRef

Inherited from Any

Ungrouped