zio-http
API
Generated with
zio-http/zio.http/zio.http.codec/HttpCodec

HttpCodec

zio.http.codec.HttpCodec
See theHttpCodec companion trait
object HttpCodec

Attributes

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

Members list

Type members

Classlikes

final case class Enumeration[Value](unit: Unit) extends AnyVal

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
object Metadata

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Metadata.type
sealed trait Metadata[Value]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Deprecated[A]
class Documented[A]
class Examples[A]
class Named[A]
class Optional[A]

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def empty: HttpCodec[Any, Unit]
def enumeration[Value]: Enumeration[Value]
def error[Body0](status: Status)(implicit schema: Schema[Body0]): HttpCodec[Status & Content, Body0]

Inherited methods

def CustomStatus(code: Int, reasonPhrase: String): StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
def CustomStatus(code: Int): StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
def binaryStream(mediaType: MediaType): ContentCodec[ZStream[Any, Nothing, Byte]]

Attributes

Inherited from:
ContentCodecs (hidden)
def binaryStream(name: String, mediaType: MediaType): ContentCodec[ZStream[Any, Nothing, Byte]]

Attributes

Inherited from:
ContentCodecs (hidden)
def binaryStream: ContentCodec[ZStream[Any, Nothing, Byte]]

Attributes

Inherited from:
ContentCodecs (hidden)
def binaryStream(name: String): ContentCodec[ZStream[Any, Nothing, Byte]]

Attributes

Inherited from:
ContentCodecs (hidden)
def connect: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def content[A](mediaType: MediaType)(implicit codec: HttpContentCodec[A]): ContentCodec[A]

Attributes

Inherited from:
ContentCodecs (hidden)
def content[A](name: String, mediaType: MediaType)(implicit codec: HttpContentCodec[A]): ContentCodec[A]

Attributes

Inherited from:
ContentCodecs (hidden)
def content[A](implicit codec: HttpContentCodec[A]): ContentCodec[A]

Attributes

Inherited from:
ContentCodecs (hidden)
def content[A](name: String)(implicit codec: HttpContentCodec[A]): ContentCodec[A]

Attributes

Inherited from:
ContentCodecs (hidden)
def contentStream[A](mediaType: MediaType)(implicit codec: HttpContentCodec[A]): ContentCodec[ZStream[Any, Nothing, A]]

Attributes

Inherited from:
ContentCodecs (hidden)
def contentStream[A](name: String, mediaType: MediaType)(implicit codec: HttpContentCodec[A]): ContentCodec[ZStream[Any, Nothing, A]]

Attributes

Inherited from:
ContentCodecs (hidden)
def contentStream[A](implicit codec: HttpContentCodec[A]): ContentCodec[ZStream[Any, Nothing, A]]

Attributes

Inherited from:
ContentCodecs (hidden)
def contentStream[A](name: String)(implicit codec: HttpContentCodec[A]): ContentCodec[ZStream[Any, Nothing, A]]

Attributes

Inherited from:
ContentCodecs (hidden)
def delete: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def get: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def head: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def header(headerType: HeaderType): HeaderCodec[headerType.HeaderValue]

Attributes

Inherited from:
HeaderCodecs (hidden)
def headerAs[A](name: String)(implicit schema: Schema[A]): HeaderCodec[A]

Attributes

Inherited from:
HeaderCodecs (hidden)
def headers[A](implicit schema: Schema[A]): HeaderCodec[A]

Attributes

Inherited from:
HeaderCodecs (hidden)
def method(method: Method): HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def options: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def patch: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def post: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def put: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)
def query[A](implicit schema: Schema[A]): QueryCodec[A]

Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

Retrieves query parameters as a value of the specified type. The type must have a schema and be a case class and all fields must be query parameters. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Query parameters are selected by field names.

Attributes

Inherited from:
QueryCodecs (hidden)
def query[A](name: String)(implicit schema: Schema[A]): QueryCodec[A]

Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the query parameter with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
QueryCodecs (hidden)
def status(status: Status): StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
def trace: HttpCodec[Method, Unit]

Attributes

Inherited from:
MethodCodecs (hidden)

Deprecated and Inherited methods

def name[A](name: String)(implicit codec: TextCodec[A]): HeaderCodec[A]

Attributes

Deprecated
[Since version 3.1.0] Use Schema based headerAs instead
Inherited from:
HeaderCodecs (hidden)
def nameTransform[A, B](name: String, parse: B => A, render: A => B)(implicit codec: TextCodec[B]): HeaderCodec[A]

Attributes

Deprecated
[Since version 3.1.0] Use Schema based API instead
Inherited from:
HeaderCodecs (hidden)
def nameTransformOption[A, B](name: String, parse: B => Option[A], render: A => B)(implicit codec: TextCodec[B]): HeaderCodec[A]

Attributes

Deprecated
[Since version 3.1.0] Use Schema based API instead
Inherited from:
HeaderCodecs (hidden)
def nameTransformOrFail[A, B](name: String, parse: B => Either[String, A], render: A => B)(implicit codec: TextCodec[B]): HeaderCodec[A]

Attributes

Deprecated
[Since version 3.1.0] Use Schema based API instead
Inherited from:
HeaderCodecs (hidden)
def queryAll[A](implicit schema: Schema[A]): QueryCodec[A]

Attributes

Deprecated
[Since version 3.1.0] Use query[A] instead
Inherited from:
QueryCodecs (hidden)

Inherited fields

val Accepted: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val BadGateway: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val BadRequest: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Conflict: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Continue: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Created: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val ExpectationFailed: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val FailedDependency: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Forbidden: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Found: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val GatewayTimeout: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Gone: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val HttpVersionNotSupported: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val InsufficientStorage: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val InternalServerError: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val LengthRequired: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Locked: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val MethodNotAllowed: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val MisdirectedRequest: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val MovedPermanently: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val MultiStatus: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val MultipleChoices: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NetworkAuthenticationRequired: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NoContent: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NonAuthoritativeInformation: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NotAcceptable: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NotExtended: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NotFound: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NotImplemented: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val NotModified: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Ok: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val PartialContent: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val PaymentRequired: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val PermanentRedirect: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val PreconditionFailed: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val PreconditionRequired: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Processing: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val ProxyAuthenticationRequired: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val RequestEntityTooLarge: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val RequestHeaderFieldsTooLarge: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val RequestTimeout: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val RequestUriTooLong: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val RequestedRangeNotSatisfiable: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val ResetContent: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val SeeOther: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val ServiceUnavailable: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val SwitchingProtocols: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val TemporaryRedirect: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val TooManyRequests: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val Unauthorized: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val UnorderedCollection: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val UnprocessableEntity: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val UnsupportedMediaType: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val UpgradeRequired: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val UseProxy: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
val VariantAlsoNegotiates: StatusCodec[Unit]

Attributes

Inherited from:
StatusCodecs (hidden)
final val accept: HeaderCodec[Accept]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val acceptEncoding: HeaderCodec[AcceptEncoding]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val acceptLanguage: HeaderCodec[AcceptLanguage]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val acceptPatch: HeaderCodec[AcceptPatch]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val acceptRanges: HeaderCodec[AcceptRanges]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlAllowCredentials: HeaderCodec[AccessControlAllowCredentials]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlAllowHeaders: HeaderCodec[AccessControlAllowHeaders]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlAllowMethods: HeaderCodec[AccessControlAllowMethods]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlAllowOrigin: HeaderCodec[AccessControlAllowOrigin]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlExposeHeaders: HeaderCodec[AccessControlExposeHeaders]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlMaxAge: HeaderCodec[AccessControlMaxAge]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlRequestHeaders: HeaderCodec[AccessControlRequestHeaders]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val accessControlRequestMethod: HeaderCodec[AccessControlRequestMethod]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val age: HeaderCodec[Age]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val allow: HeaderCodec[Allow]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val authorization: HeaderCodec[Authorization]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val basicAuth: HeaderCodec[Basic]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val bearerAuth: HeaderCodec[Bearer]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val cacheControl: HeaderCodec[CacheControl]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val clearSiteData: HeaderCodec[ClearSiteData]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val connection: HeaderCodec[Connection]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentBase: HeaderCodec[ContentBase]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentDisposition: HeaderCodec[ContentDisposition]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentEncoding: HeaderCodec[ContentEncoding]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentLanguage: HeaderCodec[ContentLanguage]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentLength: HeaderCodec[ContentLength]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentLocation: HeaderCodec[ContentLocation]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentMd5: HeaderCodec[ContentMd5]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentRange: HeaderCodec[ContentRange]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentSecurityPolicy: HeaderCodec[ContentSecurityPolicy]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentTransferEncoding: HeaderCodec[ContentTransferEncoding]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val contentType: HeaderCodec[ContentType]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val date: HeaderCodec[Date]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val digestAuth: HeaderCodec[Digest]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val dnt: HeaderCodec[DNT]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val etag: HeaderCodec[ETag]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val expect: HeaderCodec[Expect]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val expires: HeaderCodec[Expires]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val forwarded: HeaderCodec[Forwarded]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val from: HeaderCodec[From]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val host: HeaderCodec[Host]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val ifMatch: HeaderCodec[IfMatch]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val ifModifiedSince: HeaderCodec[IfModifiedSince]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val ifNoneMatch: HeaderCodec[IfNoneMatch]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val ifRange: HeaderCodec[IfRange]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val ifUnmodifiedSince: HeaderCodec[IfUnmodifiedSince]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val lastModified: HeaderCodec[LastModified]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val location: HeaderCodec[Location]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val maxForwards: HeaderCodec[MaxForwards]

Attributes

Inherited from:
HeaderCodecs (hidden)
val method: HttpCodec[Method, Method]

Attributes

Inherited from:
MethodCodecs (hidden)
final val origin: HeaderCodec[Origin]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val pragma: HeaderCodec[Pragma]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val proxyAuthenticate: HeaderCodec[ProxyAuthenticate]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val proxyAuthorization: HeaderCodec[ProxyAuthorization]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val range: HeaderCodec[Range]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val referer: HeaderCodec[Referer]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val retryAfter: HeaderCodec[RetryAfter]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketAccept: HeaderCodec[SecWebSocketAccept]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketExtensions: HeaderCodec[SecWebSocketExtensions]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketKey: HeaderCodec[SecWebSocketKey]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketLocation: HeaderCodec[SecWebSocketLocation]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketOrigin: HeaderCodec[SecWebSocketOrigin]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketProtocol: HeaderCodec[SecWebSocketProtocol]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val secWebSocketVersion: HeaderCodec[SecWebSocketVersion]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val server: HeaderCodec[Server]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val setCookie: HeaderCodec[SetCookie]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val te: HeaderCodec[Te]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val trailer: HeaderCodec[Trailer]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val transferEncoding: HeaderCodec[TransferEncoding]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val upgrade: HeaderCodec[Upgrade]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val upgradeInsecureRequests: HeaderCodec[UpgradeInsecureRequests]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val userAgent: HeaderCodec[UserAgent]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val vary: HeaderCodec[Vary]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val via: HeaderCodec[Via]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val webSocketLocation: HeaderCodec[SecWebSocketLocation]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val webSocketOrigin: HeaderCodec[SecWebSocketOrigin]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val webSocketProtocol: HeaderCodec[SecWebSocketProtocol]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val wwwAuthenticate: HeaderCodec[WWWAuthenticate]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val xFrameOptions: HeaderCodec[XFrameOptions]

Attributes

Inherited from:
HeaderCodecs (hidden)
final val xRequestedWith: HeaderCodec[XRequestedWith]

Attributes

Inherited from:
HeaderCodecs (hidden)
Generated with