Packages

final class Response[F[_]] extends Message[F] with Product with Serializable

Representation of the HTTP response to send back to the client

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

Type Members

  1. type Self = SelfF[F]
    Definition Classes
    Message
  2. type SelfF[F0[_]] = Response[F0]
    Definition Classes
    Response → Message

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addCookie(name: String, content: String, expires: Option[HttpDate] = None): Response[F]

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

  5. def addCookie(cookie: ResponseCookie): Response[F]

    Add a Set-Cookie header for the provided ResponseCookie

  6. def addHeader[H](h: H)(implicit arg0: Header[H, Recurring]): Self

    Add a header to these headers.

    Add a header to these headers. The header should be a type with a recurring Header instance to ensure that the new value can be appended to any existing values.

    >>> import cats.effect.IO
>>> import org.http4s.headers.Accept

>>> val req = Request[IO]().addHeader(Accept(MediaRange.`application/*`))
>>> req.headers.get[Accept]
Some(Accept(NonEmptyList(application/*)))

>>> val req2 = req.addHeader(Accept(MediaRange.`text/*`))
>>> req2.headers.get[Accept]
Some(Accept(NonEmptyList(application/*, text/*)))

    */*/*/*/*/

    Definition Classes
    Message
  7. 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
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. 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
  10. val attributes: Vault
    Definition Classes
    Response → Message
  11. val body: EntityBody[F]
    Definition Classes
    Response → Message → Media
  12. final def bodyText(implicit RT: RaiseThrowable[F], defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Media
  13. def canEqual(that: Any): Boolean
    Definition Classes
    Response → Equals
  14. def change(httpVersion: HttpVersion, body: EntityBody[F], headers: Headers, attributes: Vault): Response[F]
    Attributes
    protected
    Definition Classes
    Response → Message
  15. final def charset: Option[Charset]
    Definition Classes
    Media
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. final def contentLength: Option[Long]
    Definition Classes
    Media
  18. final def contentType: Option[Content-Type]
    Definition Classes
    Media
  19. 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.

  20. def copy(status: Status = this.status, httpVersion: HttpVersion = this.httpVersion, headers: Headers = this.headers, body: EntityBody[F] = this.body, attributes: Vault = this.attributes): Response[F]
  21. 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
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def filterHeaders(f: (Raw) ⇒ 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
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    Response → AnyRef → Any
  28. val headers: Headers
    Definition Classes
    Response → Message → Media
  29. val httpVersion: HttpVersion
    Definition Classes
    Response → Message
  30. def isChunked: Boolean
    Definition Classes
    Message
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def mapK[G[_]](f: ~>[F, G]): Response[G]
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. def productArity: Int
    Definition Classes
    Response → Product
  37. def productElement(n: Int): Any
    Definition Classes
    Response → Product
  38. def productIterator: Iterator[Any]
    Definition Classes
    Product
  39. def productPrefix: String
    Definition Classes
    Product
  40. def putHeaders(headers: ToRaw*): 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

    >>> import cats.effect.IO
>>> import org.http4s.headers.Accept

>>> val req = Request[IO]().putHeaders(Accept(MediaRange.`application/*`))
>>> req.headers.get[Accept]
Some(Accept(NonEmptyList(application/*)))

>>> val req2 = req.putHeaders(Accept(MediaRange.`text/*`))
>>> req2.headers.get[Accept]
Some(Accept(NonEmptyList(text/*)))

    */*/*/*/

    Definition Classes
    Message
  41. def removeCookie(name: String): Response[F]

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

  42. def removeCookie(cookie: ResponseCookie): Response[F]

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

  43. def removeHeader[A](implicit h: Header[A, _]): Self
    Definition Classes
    Message
  44. def removeHeader(key: CIString): Self
    Definition Classes
    Message
  45. def responsePrelude: ResponsePrelude

    A projection of this response without the body.

  46. val status: Status
  47. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  48. def toString(): String
    Definition Classes
    Response → AnyRef → Any
  49. 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
  50. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    Message
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  54. 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
  55. def withAttributes(attributes: Vault): Self
    Definition Classes
    Message
  56. 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
  57. def withContentType(contentType: Content-Type): Self
    Definition Classes
    Message
  58. def withContentTypeOption(contentTypeO: Option[Content-Type]): Self
    Definition Classes
    Message
  59. 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
  60. 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
  61. def withHeaders(headers: ToRaw*): Self
    Definition Classes
    Message
  62. def withHeaders(headers: Headers): Self
    Definition Classes
    Message
  63. def withHttpVersion(httpVersion: HttpVersion): Self
    Definition Classes
    Message
  64. def withStatus(status: Status): Response[F]
  65. def withTrailerHeaders(trailerHeaders: F[Headers]): Self
    Definition Classes
    Message
  66. 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
  67. def withoutContentType: Self
    Definition Classes
    Message
  68. def withoutTrailerHeaders: Self
    Definition Classes
    Message

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Message[F]

Inherited from Media[F]

Inherited from AnyRef

Inherited from Any

Ungrouped