c

org.http4s.syntax

EffectResponseOps

final class EffectResponseOps[F[_]] extends AnyVal with EffectMessageSyntax[F, Response[F]] with ResponseOps[F]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EffectResponseOps
  2. ResponseOps
  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 EffectResponseOps(self: F[Response[F]])

Type Members

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to any2stringadd[EffectResponseOps[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EffectResponseOps[F], B)
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to ArrowAssoc[EffectResponseOps[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  6. final def addCookie(name: String, content: String, expires: Option[HttpDate] = None)(implicit F: Functor[F]): 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: ResponseCookie)(implicit F: Functor[F]): 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 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. 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
  11. def ensuring(cond: (EffectResponseOps[F]) ⇒ Boolean, msg: ⇒ Any): EffectResponseOps[F]
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to Ensuring[EffectResponseOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (EffectResponseOps[F]) ⇒ Boolean): EffectResponseOps[F]
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to Ensuring[EffectResponseOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): EffectResponseOps[F]
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to Ensuring[EffectResponseOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): EffectResponseOps[F]
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to Ensuring[EffectResponseOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. 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
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to StringFormat[EffectResponseOps[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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
  20. final def removeCookie(name: String)(implicit F: Functor[F]): 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
  21. final def removeCookie(cookie: ResponseCookie)(implicit F: Functor[F]): 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
  22. final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  23. 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
  24. 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
  25. val self: F[Response[F]]
    Definition Classes
    EffectResponseOps → EffectMessageSyntax
  26. def toString(): String
    Definition Classes
    Any
  27. def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self
    Definition Classes
    EffectMessageSyntax → MessageOps
  28. 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
  29. 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
  30. final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  31. final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  32. def withEntity[T](b: T)(implicit F: Functor[F], w: EntityEncoder[F, T]): Self
    Definition Classes
    EffectMessageSyntax
  33. def withStatus(status: Status)(implicit F: Functor[F]): 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
    EffectResponseOps → ResponseOps
  34. final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  35. 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
  36. final def withoutContentType(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  37. def →[B](y: B): (EffectResponseOps[F], B)
    Implicit
    This member is added by an implicit conversion from EffectResponseOps[F] to ArrowAssoc[EffectResponseOps[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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

Inherited from ResponseOps[F]

Inherited from EffectMessageSyntax[F, Response[F]]

Inherited from MessageOps[F]

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd from EffectResponseOps[F] to any2stringadd[EffectResponseOps[F]]

Inherited by implicit conversion StringFormat from EffectResponseOps[F] to StringFormat[EffectResponseOps[F]]

Inherited by implicit conversion Ensuring from EffectResponseOps[F] to Ensuring[EffectResponseOps[F]]

Inherited by implicit conversion ArrowAssoc from EffectResponseOps[F] to ArrowAssoc[EffectResponseOps[F]]

Ungrouped