Type Members

1.  sealed trait Alternator[L, R] extends AnyRef

   A alternator is a type class responsible for combining invariant type parameters using an either.

   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.

2.  trait AlternatorLowPriority1 extends AlternatorLowPriority2
3.  trait AlternatorLowPriority2 extends AlternatorLowPriority3
4.  trait AlternatorLowPriority3 extends AnyRef
5.  final case class BinaryCodecWithSchema[A](codec: BinaryCodec[A], schema: Schema[A]) extends Product with Serializable
6.  sealed trait Combiner[L, R] extends AnyRef

   A combiner is a type class responsible for combining invariant type parameters using a tuple.

   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.

7.  trait CombinerLowPriority1 extends CombinerLowPriority2
8.  trait CombinerLowPriority2 extends CombinerLowPriority3
9.  trait CombinerLowPriority3 extends CombinerLowPriority4
10.  trait CombinerLowPriority4 extends CombinerLowPriority5
11.  trait CombinerLowPriority5 extends CombinerLowPriority6
12.  trait CombinerLowPriority6 extends AnyRef
13.  type ContentCodec[A] = HttpCodec[Content, A]
14.  sealed trait Doc extends AnyRef

    A Doc models documentation for an endpoint or input.

15.  type HeaderCodec[A] = HttpCodec[codec.HttpCodecType.Header, A]
16.  sealed trait HttpCodec[-AtomTypes, Value] extends AnyRef

    A zio.http.codec.HttpCodec represents a codec for a part of an HTTP request.

    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.

17.  sealed trait HttpCodecError extends Exception with NoStackTrace with Product with Serializable
18.  sealed trait HttpCodecType extends AnyRef
19.  final case class HttpContentCodec[A](choices: ListMap[MediaType, BinaryCodecWithSchema[A]]) extends Product with Serializable
20.  type MethodCodec[A] = HttpCodec[codec.HttpCodecType.Method, A]
21.  sealed trait PathCodec[A] extends AnyRef

    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")

22.  type QueryCodec[A] = HttpCodec[Query, A]
23.  sealed abstract class RichTextCodec[A] extends AnyRef

    A RichTextCodec is a more compositional version of TextCodec, which has similar power to traditional parser combinators / pretty printers.

    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.

24.  sealed trait SegmentCodec[A] extends AnyRef
25.  sealed trait SimpleCodec[Input, Output] extends PartialFunction[Input, Output]

    A simple codec is either equal to a given value, or unconstrained within a domain of values.

    A simple codec is either equal to a given value, or unconstrained within a domain of values. There are no other possibilities.

26.  type StatusCodec[A] = HttpCodec[codec.HttpCodecType.Status, A]
27.  sealed trait TextCodec[A] extends PartialFunction[String, A]

    A zio.http.codec.TextCodec defines a codec for 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.