org.http4s

ResponseOps

trait ResponseOps extends MessageOps

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ResponseOps
  2. MessageOps
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Self

    Definition Classes
    MessageOps

Abstract Value Members

  1. abstract 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
    MessageOps
  2. abstract 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
  3. abstract def getClass(): Class[_]

    Definition Classes
    Any
  4. abstract 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
  5. abstract 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
  6. abstract 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
    MessageOps
  7. abstract def withStatus[S](status: S)(implicit arg0: (S) ⇒ Status): Self

    Change the status of this response object

    Change the status of this response object

    S

    type that can be converted to a Status

    status

    value to replace on the response object

    returns

    a new response object with the new status code

Concrete Value Members

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

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

    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  4. def addCookie(name: String, content: String, expires: Option[Instant] = None): Self

    Add a Set-Cookie header with the provided values

  5. def addCookie(cookie: Cookie): Self

    Add a Set-Cookie header for the provided Cookie

  6. 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
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def equals(arg0: Any): Boolean

    Definition Classes
    Any
  9. def hashCode(): Int

    Definition Classes
    Any
  10. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  11. def removeCookie(name: String): Self

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

  12. def removeCookie(cookie: Cookie): Self

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

  13. def removeHeader(key: HeaderKey): Self

    Definition Classes
    MessageOps
  14. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  15. def toString(): String

    Definition Classes
    Any
  16. 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
  17. def withContentType(contentType: Option[Content-Type]): Self

    Definition Classes
    MessageOps
  18. def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Definition Classes
    MessageOps
  19. def withType(t: MediaType): Self

    Added the `Content-Type` header to the response

    Added the `Content-Type` header to the response

    Definition Classes
    MessageOps

Deprecated Value Members

  1. final def withHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

  2. final def withHeaders(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
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

Inherited from MessageOps

Inherited from Any

Ungrouped