Request
Related Docs:
object Request
| package http4s
Add a Cookie header with the provided values
Add a Cookie header with the provided values
Add a Cookie header for the provided Cookie
Add a Cookie header for the provided Cookie
Decode the Message to the specified type
type of the result
EntityDecoder used to decode the Message
the effect which will generate the T
Decode the Message to the specified type
Decode the Message to the specified type
type of the result
EntityDecoder used to decode the Message
the effect which will generate the DecodeResult[T]
Immutable Map used for carrying additional information in a type safe fashion
fs2.Stream[F, Byte] defining the body of the request
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.
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.
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.
Like decode, but with an explicit decoder.
Like decode, but with an explicit decoder.
If strict, will return a Status.UnsupportedMediaType http Response if this message's MediaType is not supported by the provided decoder
Remove headers that satisfy the predicate
Remove headers that satisfy the predicate
predicate
a new message object which lacks the specified headers
Returns the the forwardFor value if present, else the remote address.
collection of Headers
the HTTP version
Whether the Request was received over a secure medium
Method.GET, Method.POST, etc.
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.
| Query String | Map |
|---|---|
?param=v | Map("param" -> Seq("v")) |
?param= | Map("param" -> Seq("")) |
?param | Map("param" -> Seq()) |
?=value | Map("" -> Seq("value")) |
?p1=v1&p1=v2&p2=v3&p2=v3 | Map("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.
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.
multiParams
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.
Replace the existing headers with those provided
Replace the existing headers with those provided
Replaces the Headers of the incoming Request object
Replaces the Headers of the incoming Request object
Headers containing the desired headers
a new Request object
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 task might not complete unless the entire body has been consumed.
representation of the request URI
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
type of the value to store
AttributeKey with which to associate the value
value associated with the key
a new message object with the key/value pair appended
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
type of the value to store
AttributeEntry entry to add
a new message object with the key/value pair appended
Replace the body of this message with a new body
Replace the body of this message with a new body
type of the Body
body to attach to this method
EntityEncoder with which to convert the body to an EntityBody
a new message with the new body
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 withBody,
which uses an EntityEncoder to maintain the headers.
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.
Added the org.http4s.headers.Content-Type header to the response
Added the org.http4s.headers.Content-Type header to the response
(Since version 0.17.0-M3) Copy method is unsafe for setting path info. Use with... methods instead
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.