zio.http.codec
Members list
Packages
Type members
Classlikes
A alternator is a type class responsible for combining invariant type parameters using an either. It is used to compose parameters of the zio.http.codec.HttpCodec data type.
A alternator is a type class responsible for combining invariant type parameters using an either. It is used to compose parameters of the zio.http.codec.HttpCodec data type.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Supertypes
-
trait AlternatorLowPriority1trait AlternatorLowPriority2trait AlternatorLowPriority3class Objecttrait Matchableclass AnyShow all
- Self type
-
Alternator.type
Attributes
- Supertypes
- Known subtypes
-
object Alternator.type
Attributes
- Supertypes
- Known subtypes
-
trait AlternatorLowPriority1object Alternator.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
A combiner is a type class responsible for combining invariant type parameters using a tuple. It is used to compose the parameters of the zio.http.codec.HttpCodec data type.
A combiner is a type class responsible for combining invariant type parameters using a tuple. It is used to compose the parameters of the zio.http.codec.HttpCodec data type.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Supertypes
-
trait CombinerLowPriority1trait CombinerLowPriority2trait CombinerLowPriority3trait CombinerLowPriority4trait CombinerLowPriority5trait CombinerLowPriority6class Objecttrait Matchableclass AnyShow all
- Self type
-
Combiner.type
Attributes
- Supertypes
-
trait CombinerLowPriority2trait CombinerLowPriority3trait CombinerLowPriority4trait CombinerLowPriority5trait CombinerLowPriority6class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
object Combiner.type
Attributes
- Supertypes
-
trait CombinerLowPriority3trait CombinerLowPriority4trait CombinerLowPriority5trait CombinerLowPriority6class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait CombinerLowPriority1object Combiner.type
Attributes
- Supertypes
-
trait CombinerLowPriority4trait CombinerLowPriority5trait CombinerLowPriority6class Objecttrait Matchableclass AnyShow all
- Known subtypes
Attributes
- Supertypes
- Known subtypes
-
trait CombinerLowPriority3trait CombinerLowPriority2trait CombinerLowPriority1object Combiner.type
Attributes
- Supertypes
- Known subtypes
-
trait CombinerLowPriority4trait CombinerLowPriority3trait CombinerLowPriority2trait CombinerLowPriority1object Combiner.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait CombinerLowPriority5trait CombinerLowPriority4trait CombinerLowPriority3trait CombinerLowPriority2trait CombinerLowPriority1object Combiner.typeShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
ContentCodec.type
A Doc
models documentation for an endpoint or input.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HeaderCodec.type
A zio.http.codec.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 zio.http.codec.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.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Attributes
- Companion
- object
- Supertypes
-
trait NoStackTraceclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class CustomErrorclass InvalidEntityclass MalformedBodyclass MalformedHeaderclass MalformedMethodclass MalformedPathclass MalformedQueryParamclass MalformedStatusclass MissingHeaderclass MissingQueryParamclass PathTooShortclass UnsupportedContentTypeShow all
Attributes
- Companion
- trait
- Supertypes
- Self type
-
HttpCodecError.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HttpCodecType.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Self type
Attributes
- Companion
- class
- Supertypes
- Self type
-
HttpContentCodec.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
MethodCodec.type
A codec for paths, which consists of segments, where each segment may be a literal, an integer, a long, a string, a UUID, or the trailing path.
A codec for paths, which consists of segments, where each segment may be a literal, an integer, a long, a string, a UUID, or the trailing path.
import zio.http.endpoint.PathCodec._
val pathCodec = empty / "users" / int("user-id") / "posts" / string("post-id")
Attributes
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
QueryCodec.type
A RichTextCodec
is a more compositional version of TextCodec
, which has similar power to traditional parser combinators / pretty printers. Although slower than the simpler text codecs, they can be utilized to parse structured information in HTTP headers, which in turn allows generating much better error messages and documentation than otherwise possible.
A RichTextCodec
is a more compositional version of TextCodec
, which has similar power to traditional parser combinators / pretty printers. Although slower than the simpler text codecs, they can be utilized to parse structured information in HTTP headers, which in turn allows generating much better error messages and documentation than otherwise possible.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Companion
- class
- Supertypes
- Self type
-
RichTextCodec.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object Trailing.type
- Self type
-
SegmentCodec[A]
Attributes
- Companion
- trait
- Supertypes
- Self type
-
SegmentCodec.type
A simple codec is either equal to a given value, or unconstrained within a domain of values. There are no other possibilities.
A simple codec is either equal to a given value, or unconstrained within a domain of values. There are no other possibilities.
Attributes
- Companion
- object
- Supertypes
-
trait PartialFunction[Input, Output]trait Input => Outputclass Objecttrait Matchableclass Any
- Known subtypes
-
class Specified[A]class Unspecified[A]
Attributes
- Companion
- trait
- Supertypes
- Self type
-
SimpleCodec.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
StatusCodec.type
A zio.http.codec.TextCodec defines a codec for a text fragment. The text fragment can be decoded into a value, or the value can be encoded into a text fragment.
A zio.http.codec.TextCodec defines a codec for a text fragment. The text fragment can be decoded into a value, or the value can be encoded into a text fragment.
Unlike parsers, text codecs operate on entire fragments. They do not consume input and leave remainders. Also unlike parsers, text codecs do not fail with error messages, but rather, simply return None if they do not succeed in decoding from a given text fragment. Finally, unlike ordinary parsers, text codecs are fully invertible, and can therefore be used in client generation.
Attributes
- Companion
- object
- Supertypes
-
trait PartialFunction[String, A]trait String => Aclass Objecttrait Matchableclass Any
- Known subtypes
-
object BooleanCodec.typeclass Constantobject IntCodec.typeobject LongCodec.typeobject StringCodec.typeobject UUIDCodec.typeShow all
- Self type
-
TextCodec[A]