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 MaybeResponse[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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Response
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ResponseOps
  7. MaybeResponse
  8. Message
  9. MessageOps
  10. AnyRef
  11. 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
    ResponseMessageMessageOps

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Response[F] to any2stringadd[Response[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Response[F], B)
    Implicit
    This member is added by an implicit conversion from Response[F] to ArrowAssoc[Response[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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
  7. final def addCookie(cookie: Cookie)(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
  8. 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def asMaybeResponse: MaybeResponse[F]
  11. 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
    MessageMessageOps
  12. val attributes: AttributeMap
    Definition Classes
    ResponseMessage
  13. val body: EntityBody[F]
    Definition Classes
    ResponseMessage
  14. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Message
  15. def cata[A](f: (Response[F]) ⇒ A, a: ⇒ A): A
    Definition Classes
    MaybeResponse
  16. def change(body: EntityBody[F], headers: Headers, attributes: AttributeMap): Self
    Attributes
    protected
    Definition Classes
    ResponseMessage
  17. 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
  18. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def contentLength: Option[Long]
    Definition Classes
    Message
  20. def contentType: Option[Content-Type]
    Definition Classes
    Message
  21. def cookies: List[Cookie]

    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.

  22. def ensuring(cond: (Response[F]) ⇒ Boolean, msg: ⇒ Any): Response[F]
    Implicit
    This member is added by an implicit conversion from Response[F] to Ensuring[Response[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: (Response[F]) ⇒ Boolean): Response[F]
    Implicit
    This member is added by an implicit conversion from Response[F] to Ensuring[Response[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean, msg: ⇒ Any): Response[F]
    Implicit
    This member is added by an implicit conversion from Response[F] to Ensuring[Response[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean): Response[F]
    Implicit
    This member is added by an implicit conversion from Response[F] to Ensuring[Response[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. 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
  28. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Response[F] to StringFormat[Response[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  31. val headers: Headers
    Definition Classes
    ResponseMessage
  32. val httpVersion: HttpVersion
    Definition Classes
    ResponseMessage
  33. def isChunked: Boolean
    Definition Classes
    Message
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  38. def orElse[B >: Response[F]](b: ⇒ B): B
    Definition Classes
    MaybeResponse
  39. def orNotFound: Response[F]
    Definition Classes
    MaybeResponse
  40. 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
  41. 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
  42. final def removeCookie(cookie: Cookie)(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
  43. final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  44. 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
  45. 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
  46. val status: Status
  47. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  48. def toOption: Option[Response[F]]
    Definition Classes
    MaybeResponse
  49. def toString(): String
    Definition Classes
    Response → AnyRef → Any
  50. 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
  51. def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self
    Definition Classes
    MessageMessageOps
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. 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
    MessageMessageOps
  56. 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
  57. def withBody[T](b: T)(implicit F: Monad[F], w: EntityEncoder[F, T]): F[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
  58. 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 withBody, which uses an EntityEncoder to maintain the headers.

    Definition Classes
    ResponseMessage
  59. final def withContentType(contentType: Option[Content-Type])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  60. 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
  61. 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
    ResponseResponseOps
  62. final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  63. 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
  64. def [B](y: B): (Response[F], B)
    Implicit
    This member is added by an implicit conversion from Response[F] to ArrowAssoc[Response[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ResponseOps[F]

Inherited from MaybeResponse[F]

Inherited from Message[F]

Inherited from MessageOps[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Response[F] to any2stringadd[Response[F]]

Inherited by implicit conversion StringFormat from Response[F] to StringFormat[Response[F]]

Inherited by implicit conversion Ensuring from Response[F] to Ensuring[Response[F]]

Inherited by implicit conversion ArrowAssoc from Response[F] to ArrowAssoc[Response[F]]

Ungrouped