org.http4s

TaskRequestOps

final class TaskRequestOps extends AnyVal with TaskMessageOps[Request] with RequestOps

Linear Supertypes
RequestOps, TaskMessageOps[Request], MessageOps, AnyVal, NotNull, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TaskRequestOps
  2. RequestOps
  3. TaskMessageOps
  4. MessageOps
  5. AnyVal
  6. NotNull
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TaskRequestOps(self: Task[Request])

Type Members

  1. type Self = Task[Request.Self]

    Definition Classes
    TaskMessageOpsMessageOps

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

    Definition Classes
    Any
  6. 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 ParseFailure\/T

    Definition Classes
    TaskMessageOpsMessageOps
  7. final def decode[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Helper method for decoding Requests

    Helper method for decoding Requests

    Attempt to decode the Request and, if successful, execute the continuation to get a Response. If decoding fails, a BadRequest Response is generated.

    Definition Classes
    RequestOps
  8. final def decodeStrict[A](f: (A) ⇒ Task[Response])(implicit decoder: EntityDecoder[A]): Task[Response]

    Helper method for decoding Requests

    Helper method for decoding Requests

    Attempt to decode the Request and, if successful, execute the continuation to get a Response. If decoding fails, a BadRequest Response is generated. If the decoder does not support the MediaType of the Request, a UnsupportedMediaType Response is generated instead.

    Definition Classes
    RequestOps
  9. def decodeWith[A](decoder: EntityDecoder[A], strict: Boolean)(f: (A) ⇒ Task[Response]): Task[Response]

    Like decode, but with an explicit decoder.

    Like decode, but with an explicit decoder.

    strict

    If strict, will return a Status.UnsupportedMediaType http Response if this message's MediaType is not supported by the provided decoder

    Definition Classes
    TaskRequestOpsRequestOps
  10. 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
  11. def getClass(): Class[_ <: AnyVal]

    Definition Classes
    AnyVal → Any
  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  13. 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
  14. final def removeHeader(key: HeaderKey): Self

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

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  16. 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
  17. val self: Task[Request]

    Definition Classes
    TaskRequestOpsTaskMessageOps
  18. def toString(): String

    Definition Classes
    Any
  19. def transformHeaders(f: (Headers) ⇒ Headers): Self

    Definition Classes
    TaskMessageOpsMessageOps
  20. 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
    TaskMessageOpsMessageOps
  21. 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
  22. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Self

    Add a body to the message

    Add a body to the message

    Definition Classes
    TaskMessageOps
    See also

    Message

  23. final def withContentType(contentType: Option[Content-Type]): Self

    Definition Classes
    MessageOps
  24. def withPathInfo(pi: String): Task[Request]

    Definition Classes
    TaskRequestOpsRequestOps
  25. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Definition Classes
    MessageOps
  26. final 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.

  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.

Inherited from RequestOps

Inherited from TaskMessageOps[Request]

Inherited from MessageOps

Inherited from AnyVal

Inherited from NotNull

Inherited from Any

Ungrouped