http4s
A map entry where key is constrained to only be associated with a fixed value of type T.
A key in an AttributeMap that constrains its associated value to be of type T.
A key in an AttributeMap that constrains its associated value to be of type T.
The key is uniquely defined by its reference: there are no duplicate keys, even
those with the same name and type.
An immutable map where an AttributeKey for a fixed type T can only be associated with values of type T.
An immutable map where an AttributeKey for a fixed type T can only be associated with values of type T.
Because the equality of keys is based on reference, it is therefore possible for this map to contain mappings
for keys with the same label and same types.
We need to change the order of type parameters to make partial unification trigger.
We need to change the order of type parameters to make partial unification trigger. See https://github.com/http4s/http4s/issues/1506
Indicates a problem decoding a Message.
Indicates a problem decoding a Message. This may either be a problem with the entity headers or with the entity itself.
A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A.
A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A. If an error occurs it will result in a failed effect. The default decoders provided here are not streaming, but one could implement a streaming decoder by having the value of A be some kind of streaming construct.
result type produced by the decoder
Implementations of the EntityDecoder instances
A stream of server-sent events
Abstract representation o the HTTP header
Abstract representation o the HTTP header
org.http4s.HeaderKey
A collection of HTTP Headers
An HTTP-date value represents time as an instance of Coordinated Universal Time (UTC).
An HTTP-date value represents time as an instance of Coordinated Universal Time (UTC). It expresses time at a resolution of one second. By using it over java.time.Instant in the model, we assure that if two headers render equally, their values are equal.
https://tools.ietf.org/html/rfc7231#page65
A Kleisli that produces an effect to compute an OptionT[F]] from a Request[F].
A Kleisli that produces an effect to compute an OptionT[F]] from a Request[F]. In case an OptionT.none is computed the server backend should respond with a 404. An HttpService can be run on any supported http4s server backend, such as Blaze, Jetty, or Tomcat.
An HTTP version, as seen on the start line of an HTTP request or response.
An HTTP version, as seen on the start line of an HTTP request or response.
[http://tools.ietf.org/html/rfc7230#section-2.6 RFC 7320, Section 2.6
Exception dealing with invalid body
Exception dealing with invalid body
description if what makes the body invalid
Indicates a semantic error decoding the body of an HTTP Message.
Exception dealing with invalid response
Exception dealing with invalid response
description if what makes the response invalid
Indicates an syntactic error decoding the body of an HTTP Message.
Indicates that no EntityDecoder matches the MediaType of the Message being decoded
Indicates that a Message attempting to be decoded has no MediaType and no EntityDecoder was lenient enough to accept it.
Represents a HTTP Message.
Represents a HTTP Message. The interesting subclasses are Request and Response while most of the functionality is found in MessageOps and ResponseOps
Indicates a problem decoding a Message body.
Indicates a failure to handle an HTTP Message.
An HTTP method.
An HTTP method.
[http://www.iana.org/assignments/http-methods/http-methods.xhtml IANA HTTP Method Registry]
[http://tools.ietf.org/html/rfc7231#section-4 RFC7321, Section 4]
Indicates an error parsing an HTTP Message.
Indicates an error parsing an HTTP Message.
May safely be displayed to a client to describe an error condition. Should not echo any part of a Request.
Contains any relevant details omitted from the sanitized version of the error. This may freely echo a Request.
A Quality Value.
A Quality Value. Represented as thousandths for an exact representation rounded to three decimal places.
Collection representation of a query string
Collection representation of a query string
It is a indexed sequence of key and maybe a value pairs which maps precisely to a query string, modulo the identity of separators.
When rendered, the resulting String will have the pairs separated
by '&' while the key is separated from the value with '='
type class defining the key of a query parameter Usually used in conjunction with QueryParamEncoder and QueryParamDecoder
Type class defining how to decode a QueryParameterValue into a T
Type class defining how to decode a QueryParameterValue into a T
QueryParamCodecLaws
Type class defining how to encode a T as a QueryParameterValues
Type class defining how to encode a T as a QueryParameterValues
QueryParamCodecLaws
Representation of an incoming HTTP message
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.
Representation of the HTTP response to send back to the client
Representation of the HTTP response to send back to the client
Status code and message
Headers containing all response headers
EntityBody[F] representing the possible body of the response
AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object
Representation of the HTTP response code and reason
Representation of the HTTP response code and reason
Note: the reason is not important to the protocol and is not considered in equality checks.
[http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml IANA Status Code Registry]
[http://tools.ietf.org/html/rfc7231#section-6 RFC7231, Section 6]
Representation of the Request URI
Representation of the Request URI
optional Uri Scheme. eg, http, https
optional Uri Authority. eg, localhost:8080, www.foo.bar
url-encoded string representation of the path component of the Uri.
optional Query. url-encoded.
optional Uri Fragment. url-encoded.
Simple representation of a URI Template that can be rendered as RFC6570 conform string.
Simple representation of a URI Template that can be rendered as RFC6570 conform string.
This model reflects only a subset of RFC6570.
Level 1 and Level 2 are completely modeled and Level 3 features are limited to:
(Since version 0.16) Moved to org.http4s.syntax.AllSyntax
A Service wraps a function of request type A to an effect that runs
to response type B.
A Service wraps a function of request type A to an effect that runs
to response type B. By wrapping the Service, we can compose them
using Kleisli operations.
(Since version 0.18) Deprecated in favor of just using Kleisli
This object was generated by sbt-buildinfo.
A registry of cache-directives, as listed in http://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml
EntityDecoder is used to attempt to decode an EntityBody
This companion object provides a way to create new EntityDecoders along
with some commonly used instances which can be resolved implicitly.
This package is the start of a multipart implementation for http4s.
This package is the start of a multipart implementation for http4s. It is still deficient in a few ways:
- All encoding is chunked transfers, except for entities small enough to fit into the blaze buffer. This irritates some server implementations.
- When decoding, chunks are kept in memory. Large ones should be buffered to a temp file.
- It's a bit handwavy around character sets. Things probably go horribly wrong if you're not UTF-8.
- This module is lightly tested, and its API should be considered experimental.
Enter this package at your own risk, but we'd love the feedback.