Class/Object

org.http4s

Response

Related Docs: object Response | package http4s

Permalink

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

    Permalink

    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

    Permalink
    Definition Classes
    ResponseMessageMessageOps

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def addCookie(name: String, content: String, expires: Option[Instant] = None): Self

    Permalink

    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

    Permalink

    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]

    Permalink

    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

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

    Definition Classes
    MessageMessageOps
  11. val attributes: AttributeMap

    Permalink

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

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

    Definition Classes
    ResponseMessage
  12. val body: EntityBody

    Permalink

    scalaz.stream.Process[Task,Chunk] representing the possible body of the response

    scalaz.stream.Process[Task,Chunk] representing the possible body of the response

    Definition Classes
    ResponseMessage
  13. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

    Permalink
    Definition Classes
    Message
  14. def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self

    Permalink
    Attributes
    protected
    Definition Classes
    ResponseMessage
  15. 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
  16. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    Message
  19. def ensuring(cond: (Response) ⇒ Boolean, msg: ⇒ Any): Response

    Permalink
    Implicit information
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: (Response) ⇒ Boolean): Response

    Permalink
    Implicit information
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean, msg: ⇒ Any): Response

    Permalink
    Implicit information
    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: Boolean): Response

    Permalink
    Implicit information
    This member is added by an implicit conversion from Response to Ensuring[Response] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. final def eq(arg0: AnyRef): Boolean

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

    Permalink

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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()
  27. final def getClass(): Class[_]

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

    Permalink

    Headers containing all response headers

    Headers containing all response headers

    Definition Classes
    ResponseMessage
  29. val httpVersion: HttpVersion

    Permalink
    Definition Classes
    ResponseMessage
  30. def isBodyPure: Boolean

    Permalink

    True if and only if the body is composed solely of Emits and Halt.

    True if and only if the body is composed solely of Emits and Halt. This indicates that the body can be re-run without side-effects.

    Definition Classes
    Message
  31. def isChunked: Boolean

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

    Permalink
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  36. final 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
    MessageOps
  37. final def removeCookie(name: String): Self

    Permalink

    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
  38. final def removeCookie(cookie: Cookie): Self

    Permalink

    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
  39. final def removeHeader(key: HeaderKey): Self

    Permalink
    Definition Classes
    MessageOps
  40. final def replaceAllHeaders(headers: Header*): Self

    Permalink

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  41. final def replaceAllHeaders(headers: Headers): Self

    Permalink

    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
  42. val status: Status

    Permalink

    Status code and message

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

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

    Permalink
    Definition Classes
    Response → AnyRef → Any
  45. def trailerHeaders: Task[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 task might not complete unless the entire body has been consumed.

    Definition Classes
    Message
  46. def transformHeaders(f: (Headers) ⇒ Headers): Self

    Permalink
    Definition Classes
    MessageMessageOps
  47. final def wait(): Unit

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

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

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

    Permalink

    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
  51. def withAttribute[V](entry: AttributeEntry[V]): Self

    Permalink

    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
  52. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[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
  53. final def withContentType(contentType: Option[Content-Type]): Self

    Permalink
    Definition Classes
    MessageOps
  54. def withStatus(status: Status): Self

    Permalink

    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
  55. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Permalink
    Definition Classes
    MessageOps
  56. final def withType(t: MediaType): Self

    Permalink

    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
  57. def [B](y: B): (Response, B)

    Permalink
    Implicit information
    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 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