A zio.http.api.HttpCodec represents a codec for a part of an HTTP request. HttpCodec the HTTP protocol, these parts may be the unconsumed portion of the HTTP path (a route codec), the query string parameters (a query codec), the request headers (a header codec), or the request body (a body codec).
A HttpCodec is a purely declarative description of an input, and therefore, it can be used to generate documentation, clients, and client libraries.
HttpCodecs are a bit like invertible multi-channel parsers.
- Companion:
- object
Value members
Concrete methods
Combines two query codecs into another query codec.
Combines two query codecs into another query codec.
Returns a new codec that is the composition of this codec and the specified codec. For codecs that include route codecs, the routes will be decoded sequentially from left to right.
Returns a new codec that is the composition of this codec and the specified codec. For codecs that include route codecs, the routes will be decoded sequentially from left to right.
Combines two route codecs into another route codec.
Combines two route codecs into another route codec.
Returns a new codec that is the same as this one, but has attached docs, which will render whenever docs are generated from the codec.
Returns a new codec that is the same as this one, but has attached docs, which will render whenever docs are generated from the codec.
Reinterprets this codec as a query codec assuming evidence that this interpretation is sound.
Reinterprets this codec as a query codec assuming evidence that this interpretation is sound.
Reinterpets this codec as a route codec assuming evidence that this interpretation is sound.
Reinterpets this codec as a route codec assuming evidence that this interpretation is sound.
Uses this codec to decode the Scala value from a request.
Uses this codec to decode the Scala value from a request.
Uses this codec to decode the Scala value from a response.
Uses this codec to decode the Scala value from a response.
Uses this codec to encode the Scala value into a request.
Uses this codec to encode the Scala value into a request.
Uses this codec to encode the Scala value as a response.
Uses this codec to encode the Scala value as a response.
Uses this codec to encode the Scala value as a response patch.
Uses this codec to encode the Scala value as a response patch.
Returns a new codec, where the value produced by this one is optional. This method may only be called on header and query codecs.
Returns a new codec, where the value produced by this one is optional. This method may only be called on header and query codecs.
Transforms the type parameter of this HttpCodec from Value to Value2.
Due to the fact that HttpCodec is invariant in its type parameter, the
transformation requires not just a function from Value to Value2, but
also, a function from Value2 to Value.
Transforms the type parameter of this HttpCodec from Value to Value2.
Due to the fact that HttpCodec is invariant in its type parameter, the
transformation requires not just a function from Value to Value2, but
also, a function from Value2 to Value.
One of these functions will be used in decoding, for example, when the endpoint is invoked on the server. The other of these functions will be used in encoding, for example, when a client calls the endpoint on the server.
Transforms the type parameter to Unit by specifying that all possible
values that can be decoded from this HttpCodec are in fact equivalent to
the provided canonical value.
Transforms the type parameter to Unit by specifying that all possible
values that can be decoded from this HttpCodec are in fact equivalent to
the provided canonical value.
Note: You should NOT use this method on any codec which can decode semantically distinct values.