Packages

sealed abstract case class Request[F[_]] extends Message[F] with Product with Serializable

Representation of an incoming HTTP message

A Request encapsulates the entirety of the incoming HTTP request including the status line, headers, and a possible request body.

Source
Message.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Message[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Request
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Message
  7. AnyRef
  8. 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. type Self = Request[F]
    Definition Classes
    Request → Message

Value Members

  1. def addCookie(name: String, content: String): Self

    Add a Cookie header with the provided values

  2. def addCookie(cookie: RequestCookie): Self

    Add a Cookie header for the provided Cookie

  3. def as[A](implicit F: MonadError[F, Throwable], decoder: EntityDecoder[F, A]): F[A]

    Decode the Message to the specified type

    Decode the Message to the specified type

    If no valid Status has been described, allow Ok

    A

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the effect which will generate the A

    Definition Classes
    Message
  4. def attemptAs[T](implicit 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
    Message
  5. val attributes: Vault
    Definition Classes
    Request → Message
  6. def authType: Option[AuthScheme]
  7. val body: EntityBody[F]
    Definition Classes
    Request → Message
  8. def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Message
  9. def charset: Option[Charset]

    Returns the charset parameter of the Content-Type header, if present.

    Returns the charset parameter of the Content-Type header, if present. Does not introspect the body for media types that define a charset internally.

    Definition Classes
    Message
  10. def contentLength: Option[Long]
    Definition Classes
    Message
  11. def contentType: Option[Content-Type]
    Definition Classes
    Message
  12. def cookies: List[RequestCookie]

    Parses all available Cookie headers into a list of RequestCookie objects.

    Parses all available Cookie headers into a list of RequestCookie objects. This implementation is compatible with cookie headers formatted per HTTP/1 and HTTP/2, or even both at the same time.

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

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

  15. def decodeWith[A](decoder: EntityDecoder[F, A], strict: Boolean)(f: (A) ⇒ F[Response[F]])(implicit F: Monad[F]): F[Response[F]]
  16. def filterHeaders(f: (Header) ⇒ Boolean): Self

    Keep headers that satisfy the predicate

    Keep headers that satisfy the predicate

    f

    predicate

    returns

    a new message object which has only headers that satisfy the predicate

    Definition Classes
    Message
  17. def from: Option[InetAddress]

    Returns the the X-Forwarded-For value if present, else the remote address.

  18. val headers: Headers
    Definition Classes
    Request → Message
  19. val httpVersion: HttpVersion
    Definition Classes
    Request → Message
  20. def isChunked: Boolean
    Definition Classes
    Message
  21. def isSecure: Option[Boolean]

    Whether the Request was received over a secure medium

  22. def mapK[G[_]](f: ~>[F, G]): Request[G]
  23. val method: Method
  24. def multiParams: Map[String, Seq[String]]

    Representation of the query string as a map

    Representation of the query string as a map

    In case a parameter is available in query string but no value is there the sequence will be empty. If the value is empty the the sequence contains an empty string.

    Examples

    Query StringMap
    ?param=vMap("param" -> Seq("v"))
    ?param=Map("param" -> Seq(""))
    ?paramMap("param" -> Seq())
    ?=valueMap("" -> Seq("value"))
    ?p1=v1&p1=v2&p2=v3&p2=v3Map("p1" -> Seq("v1","v2"), "p2" -> Seq("v3","v4"))

    The query string is lazily parsed. If an error occurs during parsing an empty Map is returned.

  25. def params: Map[String, String]

    View of the head elements of the URI parameters in query string.

    View of the head elements of the URI parameters in query string.

    In case a parameter has no value the map returns an empty string.

    See also

    multiParams

  26. lazy val pathInfo: String
  27. def pathTranslated: Option[File]
  28. 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
    Message
  29. def queryString: String
  30. def remote: Option[InetSocketAddress]
  31. def remoteAddr: Option[String]
  32. def remoteHost: Option[String]
  33. def remotePort: Option[Int]
  34. def remoteUser: Option[String]
  35. def removeHeader(key: HeaderKey): Self
    Definition Classes
    Message
  36. lazy val scriptName: String
  37. def server: Option[InetSocketAddress]
  38. def serverAddr: String
  39. def serverPort: Int
  40. def serverSoftware: ServerSoftware
  41. def toString(): String
    Definition Classes
    Request → AnyRef → Any
  42. def trailerHeaders(implicit F: Applicative[F]): F[Headers]

    The trailer headers, as specified in Section 3.6.1 of RFC 2616.

    The trailer headers, as specified in Section 3.6.1 of RFC 2616. The resulting F might not complete until the entire body has been consumed.

    Definition Classes
    Message
  43. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    Message
  44. val uri: Uri
  45. def withAttribute[A](key: Key[A], value: A): Self

    Generates a new message object with the specified key/value pair appended to the AttributeMap

    Generates a new message object with the specified key/value pair appended to the AttributeMap

    A

    type of the value to store

    key

    Key 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
    Message
  46. def withAttributes(attributes: Vault): Self
    Definition Classes
    Message
  47. def withBodyStream(body: EntityBody[F]): Self

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length.

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length. Most use cases are better served by withEntity, which uses an EntityEncoder to maintain the headers.

    Definition Classes
    Message
  48. def withContentType(contentType: Content-Type): Self
    Definition Classes
    Message
  49. def withContentTypeOption(contentTypeO: Option[Content-Type]): Self
    Definition Classes
    Message
  50. def withEmptyBody: Self

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

    Definition Classes
    Message
  51. def withEntity[T](b: T)(implicit w: EntityEncoder[F, T]): Self

    Replace the body of this message with a new body

    Replace the body of this message with a new body

    T

    type of the Body

    b

    body to attach to this method

    w

    EntityEncoder with which to convert the body to an EntityBody

    returns

    a new message with the new body

    Definition Classes
    Message
  52. def withHeaders(headers: Header*): Self
    Definition Classes
    Message
  53. def withHeaders(headers: Headers): Self
    Definition Classes
    Message
  54. def withHttpVersion(httpVersion: HttpVersion): Self
    Definition Classes
    Message
  55. def withMethod(method: Method): Self
  56. def withPathInfo(pi: String): Self
  57. def withTrailerHeaders(trailerHeaders: F[Headers]): Self
    Definition Classes
    Message
  58. def withUri(uri: Uri): Self
  59. def withoutAttribute(key: Key[_]): Self

    Returns a new message object without the specified key in the AttributeMap

    Returns a new message object without the specified key in the AttributeMap

    key

    Key to remove

    returns

    a new message object without the key

    Definition Classes
    Message
  60. def withoutContentType: Self
    Definition Classes
    Message
  61. def withoutTrailerHeaders: Self
    Definition Classes
    Message

Deprecated Value Members

  1. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withHeaders instead

  2. def replaceAllHeaders(headers: Headers): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withHeaders instead

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

    (Since version 0.19) Use withEntity

  4. def withType(t: MediaType)(implicit F: Functor[F]): Self
    Definition Classes
    Message
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withContentType(Content-Type(t)) instead