Packages

t

org.http4s

RequestOps

trait RequestOps[F[_]] extends MessageOps[F]

Source
MessageOps.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestOps
  2. MessageOps
  3. 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

Type Members

  1. abstract type Self
    Definition Classes
    MessageOps

Abstract Value Members

  1. abstract 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
    MessageOps
  2. abstract 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

  3. abstract def getClass(): Class[_]
    Definition Classes
    Any
  4. abstract def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  5. abstract 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
    MessageOps
  6. abstract def withPathInfo(pi: String)(implicit F: Functor[F]): Self

Concrete 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 RequestOps[F] to any2stringadd[RequestOps[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RequestOps[F], B)
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to ArrowAssoc[RequestOps[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 Cookie header with the provided values

  7. final def addCookie(cookie: Cookie)(implicit F: Functor[F]): Self

    Add a Cookie header for the provided Cookie

  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. 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.

  11. 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.

  12. def ensuring(cond: (RequestOps[F]) ⇒ Boolean, msg: ⇒ Any): RequestOps[F]
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to Ensuring[RequestOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (RequestOps[F]) ⇒ Boolean): RequestOps[F]
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to Ensuring[RequestOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): RequestOps[F]
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to Ensuring[RequestOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): RequestOps[F]
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to Ensuring[RequestOps[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def equals(arg0: Any): Boolean
    Definition Classes
    Any
  17. 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
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to StringFormat[RequestOps[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def hashCode(): Int
    Definition Classes
    Any
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
  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. def toString(): String
    Definition Classes
    Any
  26. 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
  27. final def withContentType(contentType: Option[Content-Type])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  28. final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self
    Definition Classes
    MessageOps
  29. 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
  30. def [B](y: B): (RequestOps[F], B)
    Implicit
    This member is added by an implicit conversion from RequestOps[F] to ArrowAssoc[RequestOps[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from MessageOps[F]

Inherited from Any

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

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

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

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

Ungrouped