HttpCodec

zio.blocks.endpoint.HttpCodec
See theHttpCodec companion trait
object HttpCodec

Attributes

Companion
trait
Source
HttpCodec.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
HttpCodec.type

Members list

Type members

Classlikes

final case class Body[K <: CodecKind, A](schema: Schema[A], mediaTypes: Chunk[MediaType] = ..., name: Option[String] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...) extends HttpCodec[K, A]

Request/response body descriptor.

Request/response body descriptor.

Attributes

Source
HttpCodec.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpCodec[K, A]
class Object
trait Matchable
class Any
Show all
final case class Combine[K <: CodecKind, A, B, C](left: HttpCodec[K, A], right: HttpCodec[K, B], combiner: WithOut[A, B, C]) extends HttpCodec[K, C]

Sequential combination of two codecs.

Sequential combination of two codecs.

Attributes

Source
HttpCodec.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpCodec[K, C]
class Object
trait Matchable
class Any
Show all
case object Empty extends HttpCodec[Nothing, Unit]

No additional data.

No additional data.

Attributes

Source
HttpCodec.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait HttpCodec[Nothing, Unit]
class Object
trait Matchable
class Any
Show all
Self type
Empty.type
final case class Fallback[K <: CodecKind, A, B, C](left: HttpCodec[K, A], right: HttpCodec[K, B], alternator: WithOut[A, B, C]) extends HttpCodec[K, C]

Alternative between two codecs.

Alternative between two codecs.

Attributes

Source
HttpCodec.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpCodec[K, C]
class Object
trait Matchable
class Any
Show all
final case class Header[K <: CodecKind, A](name: String, schema: Schema[A], default: Option[A] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...) extends HttpCodec[K, A]

HTTP header descriptor.

HTTP header descriptor.

Attributes

Source
HttpCodec.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpCodec[K, A]
class Object
trait Matchable
class Any
Show all
final case class Query[A](name: String, schema: Schema[A], default: Option[A] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...) extends HttpCodec[Request, A]

Query parameter descriptor.

Query parameter descriptor.

Attributes

Source
HttpCodec.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpCodec[Request, A]
class Object
trait Matchable
class Any
Show all
final case class StatusCodec(status: Option[Status] = ..., doc: Doc = ..., examples: Chunk[Status] = ..., deprecated: Option[Doc] = ...) extends HttpCodec[Response, Unit]

HTTP status code descriptor.

HTTP status code descriptor.

Attributes

Source
HttpCodec.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait HttpCodec[Response, Unit]
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def CustomStatus(code: Int): HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
def empty[K <: CodecKind]: HttpCodec[K, Unit]

Attributes

Source
HttpCodec.scala
def query[A](name: String, schema: Schema[A], default: Option[A] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...): Query[A]

Attributes

Source
HttpCodec.scala
def requestBody[A](schema: Schema[A], mediaTypes: Chunk[MediaType] = ..., name: Option[String] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...): HttpCodec[Request, A]

Attributes

Source
HttpCodec.scala
def requestHeader[A](name: String, schema: Schema[A], default: Option[A] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...): Header[Request, A]

Attributes

Source
HttpCodec.scala
def requestHeader[A](headerType: Codec[A]): Header[Request, A]

Builds a request-header codec from a zio.http.Header.Codec.

Builds a request-header codec from a zio.http.Header.Codec.

Attributes

Source
HttpCodec.scala
def responseBody[A](schema: Schema[A], mediaTypes: Chunk[MediaType] = ..., name: Option[String] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...): HttpCodec[Response, A]

Attributes

Source
HttpCodec.scala
def responseHeader[A](name: String, schema: Schema[A], default: Option[A] = ..., doc: Doc = ..., examples: Chunk[(String, A)] = ..., deprecated: Option[Doc] = ...): Header[Response, A]

Attributes

Source
HttpCodec.scala
def responseHeader[A](headerType: Codec[A]): Header[Response, A]

Builds a response-header codec from a zio.http.Header.Codec.

Builds a response-header codec from a zio.http.Header.Codec.

Attributes

Source
HttpCodec.scala
def status(status: Status, doc: Doc = ..., examples: Chunk[Status] = ..., deprecated: Option[Doc] = ...): HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala

Concrete fields

val Accepted: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val BadRequest: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val Continue: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val Created: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val Forbidden: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val InternalServerError: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val NoContent: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val NotFound: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val Ok: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val Processing: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val SwitchingProtocols: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val Unauthorized: HttpCodec[Response, Unit]

Attributes

Source
HttpCodec.scala
val basicAuth: HttpCodec[Request, Basic]

Attributes

Source
HttpCodec.scala