Packages

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

scalaz.stream.Process[Task,Chunk] 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, MaybeResponse, Message, MessageOps, AnyRef, Any
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 = EmptyBody, attributes: AttributeMap = AttributeMap.empty)

    status

    Status code and message

    headers

    Headers containing all response headers

    body

    scalaz.stream.Process[Task,Chunk] 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
    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 to any2stringadd[Response] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Response, B)
    Implicit
    This member is added by an implicit conversion from Response to ArrowAssoc[Response] 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): 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): 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 decoder: EntityDecoder[T]): Task[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 Task which will generate the T

    Definition Classes
    MessageOps
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[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 Task which will generate the DecodeResult[T]

    Definition Classes
    MessageMessageOps
  11. val attributes: AttributeMap
    Definition Classes
    ResponseMessage
  12. val body: EntityBody
    Definition Classes
    ResponseMessage
  13. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[Task, String]
    Definition Classes
    Message
  14. def cata[A](f: (Response) ⇒ A, a: ⇒ A): A
    Definition Classes
    MaybeResponse
  15. def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self
    Attributes
    protected
    Definition Classes
    ResponseMessage
  16. 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
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  18. def contentLength: Option[Long]
    Definition Classes
    Message
  19. def contentType: Option[Content-Type]
    Definition Classes
    Message
  20. 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.

  21. def ensuring(cond: (Response) ⇒ Boolean, msg: ⇒ Any): Response
    Implicit
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (Response) ⇒ Boolean): Response
    Implicit
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): Response
    Implicit
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): Response
    Implicit
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def filterHeaders(f: (Header) ⇒ Boolean): 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
  27. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Response to StringFormat[Response] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. val headers: Headers
    Definition Classes
    ResponseMessage
  31. val httpVersion: HttpVersion
    Definition Classes
    ResponseMessage
  32. def isChunked: Boolean
    Definition Classes
    Message
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def orElse[B >: Response](b: ⇒ B): B
    Definition Classes
    MaybeResponse
  38. def orNotFound: Response
    Definition Classes
    MaybeResponse
  39. final 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
    MessageOps
  40. final def removeCookie(name: String): 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
  41. final def removeCookie(cookie: Cookie): 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 removeHeader(key: HeaderKey): Self
    Definition Classes
    MessageOps
  43. final def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  44. final def replaceAllHeaders(headers: Headers): 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
  45. val status: Status
  46. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  47. def toOption: Option[Response]
    Definition Classes
    MaybeResponse
  48. def toString(): String
    Definition Classes
    Response → AnyRef → Any
  49. def trailerHeaders: Task[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
  50. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    MessageMessageOps
  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
    @native() @throws( ... )
  54. def withAttribute[A](key: AttributeKey[A], value: A): 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
  55. def withAttribute[V](entry: AttributeEntry[V]): 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
  56. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[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
  57. def withBodyStream(body: EntityBody): Response

    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
  58. final def withContentType(contentType: Option[Content-Type]): Self
    Definition Classes
    MessageOps
  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 withStatus(status: Status): 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
  61. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self
    Definition Classes
    MessageOps
  62. final def withType(t: MediaType): 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
  63. def [B](y: B): (Response, B)
    Implicit
    This member is added by an implicit conversion from Response to ArrowAssoc[Response] 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

Inherited from MaybeResponse

Inherited from Message

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped