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.

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
  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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addCookie(name: String, content: String): Self

    Add a Cookie header with the provided values

  5. def addCookie(cookie: RequestCookie): Self

    Add a Cookie header for the provided Cookie

  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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
  9. val attributes: Vault
    Definition Classes
    Request → Message
  10. def authType: Option[AuthScheme]
  11. val body: EntityBody[F]
    Definition Classes
    Request → Message
  12. def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
    Definition Classes
    Message
  13. def change(httpVersion: HttpVersion, body: EntityBody[F], headers: Headers, attributes: Vault): Self
    Attributes
    protected
    Definition Classes
    Request → Message
  14. 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
  15. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  16. def contentLength: Option[Long]
    Definition Classes
    Message
  17. def contentType: Option[Content-Type]
    Definition Classes
    Message
  18. 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.

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

  20. def decodeWith[A](decoder: EntityDecoder[F, A], strict: Boolean)(f: (A) ⇒ F[Response[F]])(implicit F: Monad[F]): F[Response[F]]
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. 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
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def from: Option[InetAddress]

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

  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. val headers: Headers
    Definition Classes
    Request → Message
  27. val httpVersion: HttpVersion
    Definition Classes
    Request → Message
  28. def isChunked: Boolean
    Definition Classes
    Message
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isSecure: Option[Boolean]

    Whether the Request was received over a secure medium

  31. def mapK[G[_]](f: ~>[F, G]): Request[G]
  32. val method: Method
  33. 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.

  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. 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

  38. lazy val pathInfo: String
  39. def pathTranslated: Option[File]
  40. 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
  41. def queryString: String
  42. def remote: Option[InetSocketAddress]
  43. def remoteAddr: Option[String]
  44. def remoteHost: Option[String]
  45. def remotePort: Option[Int]
  46. def remoteUser: Option[String]
  47. def removeHeader(key: HeaderKey): Self
    Definition Classes
    Message
  48. lazy val scriptName: String
  49. def server: Option[InetSocketAddress]
  50. def serverAddr: String
  51. def serverPort: Int
  52. def serverSoftware: ServerSoftware
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    Request → AnyRef → Any
  55. 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
  56. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    Message
  57. val uri: Uri
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  61. 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
  62. def withAttributes(attributes: Vault): Self
    Definition Classes
    Message
  63. 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
  64. def withContentType(contentType: Content-Type): Self
    Definition Classes
    Message
  65. def withContentTypeOption(contentTypeO: Option[Content-Type]): Self
    Definition Classes
    Message
  66. 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
  67. 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
  68. def withHeaders(headers: Header*): Self
    Definition Classes
    Message
  69. def withHeaders(headers: Headers): Self
    Definition Classes
    Message
  70. def withHttpVersion(httpVersion: HttpVersion): Self
    Definition Classes
    Message
  71. def withMethod(method: Method): Self
  72. def withPathInfo(pi: String): Self
  73. def withTrailerHeaders(trailerHeaders: F[Headers]): Self
    Definition Classes
    Message
  74. def withUri(uri: Uri): Self
  75. 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
  76. def withoutContentType: Self
    Definition Classes
    Message
  77. 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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Message[F]

Inherited from AnyRef

Inherited from Any

Ungrouped