c

org.http4s.syntax

EffectRequestOps

final class EffectRequestOps[F[_]] extends AnyVal with EffectMessageSyntax[F, Request[F]] with RequestOps[F]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EffectRequestOps
  2. RequestOps
  3. EffectMessageSyntax
  4. MessageOps
  5. AnyVal
  6. 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 EffectRequestOps(self: F[Request[F]])

Type Members

  1. type Self = F[Request.Self]
    Definition Classes
    EffectMessageSyntax → MessageOps

Value Members

  1. final def addCookie(name: String, content: String)(implicit F: Functor[F]): Self

    Add a Cookie header with the provided values

    Add a Cookie header with the provided values

    Definition Classes
    RequestOps
  2. final def addCookie(cookie: RequestCookie)(implicit F: Functor[F]): Self

    Add a Cookie header for the provided Cookie

    Add a Cookie header for the provided Cookie

    Definition Classes
    RequestOps
  3. final def as[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): F[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 effect which will generate the T

    Definition Classes
    MessageOps
  4. def attemptAs[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): DecodeResult[F, 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 effect which will generate the DecodeResult[T]

    Definition Classes
    EffectMessageSyntax → MessageOps
  5. final def decode[A](f: (A) ⇒ F[Response[F]])(implicit F: Monad[F], decoder: EntityDecoder[F, A]): F[Response[F]]

    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, an UnprocessableEntity Response is generated.

    Definition Classes
    RequestOps
  6. final def decodeStrict[A](f: (A) ⇒ F[Response[F]])(implicit F: Monad[F], decoder: EntityDecoder[F, A]): F[Response[F]]

    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, an UnprocessableEntity Response is generated. If the decoder does not support the MediaType of the Request, a UnsupportedMediaType Response is generated instead.

    Definition Classes
    RequestOps
  7. def decodeWith[A](decoder: EntityDecoder[F, A], strict: Boolean)(f: (A) ⇒ F[Response[F]])(implicit F: Monad[F]): F[Response[F]]

    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
    EffectRequestOps → RequestOps
  8. final def filterHeaders(f: (Header) ⇒ Boolean)(implicit F: Functor[F]): 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
  9. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  10. final def putHeaders(headers: Header*)(implicit F: Functor[F]): 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
  11. final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  12. final def replaceAllHeaders(headers: Header*)(implicit F: Functor[F]): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  13. final def replaceAllHeaders(headers: Headers)(implicit F: Functor[F]): 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
  14. val self: F[Request[F]]
    Definition Classes
    EffectRequestOps → EffectMessageSyntax
  15. def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self
    Definition Classes
    EffectMessageSyntax → MessageOps
  16. def withAttribute[A](key: AttributeKey[A], value: A)(implicit F: Functor[F]): 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
    EffectMessageSyntax → MessageOps
  17. def withAttribute[V](entry: AttributeEntry[V])(implicit F: Functor[F]): 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
  18. final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  19. final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  20. def withEntity[T](b: T)(implicit F: Functor[F], w: EntityEncoder[F, T]): Self
    Definition Classes
    EffectMessageSyntax
  21. def withPathInfo(pi: String)(implicit F: Functor[F]): F[Request[F]]
    Definition Classes
    EffectRequestOps → RequestOps
  22. final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  23. final def withType(t: MediaType)(implicit F: Functor[F]): 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
  24. final def withoutContentType(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps

Deprecated Value Members

  1. def withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): Self
    Definition Classes
    EffectMessageSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19) Use withEntity