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

zio.http

package zio.http

Members list

Packages

package zio.http.codec
package zio.http.endpoint
package zio.http.internal
package zio.http.template

Type members

Classlikes

trait Body

Represents the body of a request or response. The body can be a fixed chunk of bytes, a stream of bytes, or form data, or any type that can be encoded into such representations (such as textual data using some character encoding, the contents of files, JSON, etc.).

Represents the body of a request or response. The body can be a fixed chunk of bytes, a stream of bytes, or form data, or any type that can be encoded into such representations (such as textual data using some character encoding, the contents of files, JSON, etc.).

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class FetchBody
Self type
object Body

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Body.type
final case class Boundary(id: String, charset: Charset)

A multipart boundary, which consists of both the boundary and its charset.

A multipart boundary, which consists of both the boundary and its charset.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object Boundary

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Boundary.type
trait Channel[-In, +Out]

A Channel is an asynchronous communication channel that supports receiving messages of type In and sending messages of type Out.

A Channel is an asynchronous communication channel that supports receiving messages of type In and sending messages of type Out.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Channel[In, Out]
sealed trait ChannelEvent[+A]

Immutable and type-safe representation of events that are triggered on a netty channel. A represents the message type.

Immutable and type-safe representation of events that are triggered on a netty channel. A represents the message type.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Read[A]
object Registered.type
object Unregistered.type
Self type
object ChannelEvent

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Charsets

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Charsets.type
sealed trait ClientAuth

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NoneClientAuth.type
object Optional.type
object Required.type
object ClientAuth

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ClientAuth.type
trait ClientDriver

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ClientDriver

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ClientSSLConfig

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Default.type
class FromCertFile
object ClientSSLConfig

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ComposeLowPriorityImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ZCompose.type
trait ConnectionPool[Connection]

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait ConnectionPoolConfig

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Disabled.type
class Dynamic
class Fixed
class FixedPerHost
object ConnectionPoolConfig

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Cookie

Cookie is an immutable and type-safe representation of an HTTP cookie. There are two types of cookies: request cookies and response cookies. These can be created with the constructors in the companion object of Cookie.

Cookie is an immutable and type-safe representation of an HTTP cookie. There are two types of cookies: request cookies and response cookies. These can be created with the constructors in the companion object of Cookie.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Request
class Response
Self type
object Cookie

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Cookie.type
final case class Credentials(uname: String, upassword: Secret)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Decompression

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object No.type
object NonStrict.type
object Strict.type
object Decompression

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait DnsResolver

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object DnsResolver

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait Driver

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Driver extends DriverPlatformSpecific

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Driver.type
trait DriverPlatformSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Driver.type
sealed trait Flash[+A]

Flash represents a flash value that one can retrieve from the flash scope.

Flash represents a flash value that one can retrieve from the flash scope.

The flash scope consists of a serialized and url-encoded json object built with zio-schema.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
Flash[A]
object Flash

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Flash.type
final case class Form(formData: Chunk[FormField])

Represents a form that can be either multipart or url encoded.

Represents a form that can be either multipart or url encoded.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Form

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Form.type
sealed trait FormDecodingError extends Exception

Represents a form decoding error.

Represents a form decoding error.

Attributes

Companion
object
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
Self type
object FormDecodingError

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait FormField

Represents a field in a form. Every field contains name, content type (perhaps just plaintext), type-specific content, and an optional filename.

Represents a field in a form. Every field contains name, content type (perhaps just plaintext), type-specific content, and an optional filename.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Binary
class Simple
class Text
object FormField

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
FormField.type
sealed trait Handler[-R, +Err, -In, +Out]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
Handler[R, Err, In, Out]
object Handler extends HandlerPlatformSpecific

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Handler.type
final case class HandlerAspect[-Env, +CtxOut](protocol: ProtocolStack[Env, Request, (Request, CtxOut), Response, Response]) extends Middleware[Env]

A zio.http.HandlerAspect is a kind of zio.http.ProtocolStack that is specialized to transform a handler's incoming requests and outgoing responses. Each layer in the stack corresponds to a separate transformation.

A zio.http.HandlerAspect is a kind of zio.http.ProtocolStack that is specialized to transform a handler's incoming requests and outgoing responses. Each layer in the stack corresponds to a separate transformation.

Layers may incorporate layer-specific information into a generic type parameter, referred to as middleware context, which composes using tupling.

Layers may also be stateful at the level of each transformation application. So, for example, a layer that is timing request durations may capture the start time of the request in the incoming interceptor, and pass this state to the outgoing interceptor, which can then compute the duration.

zio.http.HandlerAspect is more than just a wrapper around zio.http.ProtocolStack, as its concatenation operator has been specialized to entuple contexts, so that each layer may only add context to the contextual output.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Middleware[Env]
class Object
trait Matchable
class Any
Show all
Self type
HandlerAspect[Env, CtxOut]
object HandlerAspect

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderModifier[HandlerAspect[Any, Unit]]
class Object
trait Matchable
class Any
Show all
Self type
trait HandlerPlatformSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Handler.type
Self type
Handler.type
sealed trait Header

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Accept
class Br
class Compress
class Deflate
class GZip
class Identity
class Multiple
class NoPreference
class Unknown
object Any.type
class Multiple
class Single
class AcceptPatch
trait AcceptRanges
object Bytes.type
object None.type
object Allow.type
object DoNotAllow.type
object All.type
object None.type
class Some
object All.type
object None.type
class Some
object All.type
class Specific
object All.type
object None.type
class Some
class Age
class Allow
class Basic
class Bearer
class Digest
class Unparsed
trait CacheControl
object Immutable.type
class MaxAge
class MaxStale
class MinFresh
class Multiple
object MustRevalidate.type
object MustUnderstand.type
object NoCache.type
object NoStore.type
object NoTransform.type
object OnlyIfCached.type
object Private.type
object ProxyRevalidate.type
object Public.type
class SMaxAge
class StaleIfError
trait Connection
object Close.type
object KeepAlive.type
class ContentBase
class Attachment
class FormField
class Inline
object Br.type
object Compress.type
object Deflate.type
object GZip.type
class Multiple
object Arabic.type
object Bulgarian.type
object Catalan.type
object Chinese.type
object Croatian.type
object Czech.type
object Danish.type
object Dutch.type
object English.type
object Estonian.type
object Finnish.type
object French.type
object German.type
object Greek.type
object Hebrew.type
object Hindi.type
object Hungarian.type
object Icelandic.type
object Indonesian.type
object Italian.type
object Japanese.type
object Korean.type
object Latvian.type
object Lithuanian.type
object Norwegian.type
object Polish.type
object Portuguese.type
object Romanian.type
object Russian.type
object Serbian.type
object Slovak.type
object Slovenian.type
object Spanish.type
object Swedish.type
object Thai.type
object Turkish.type
object Ukrainian.type
object Vietnamese.type
class ContentMd5
trait ContentRange
class EndTotal
class RangeTotal
class StartEnd
object BlockAllMixedContent.type
class PluginTypes
class Referrer
class ReportTo
class ReportUri
class Sandbox
class SourcePolicy
class TrustedTypes
object Base64.type
object Binary.type
object EightBit.type
object QuotedPrintable.type
object SevenBit.type
class XToken
class ContentType
class Cookie
class Custom
trait DNT
object NotSpecified.type
object TrackingAllowed.type
object TrackingNotAllowed.type
class Date
trait ETag
class Strong
class Weak
trait Expect
object 100-continue.type
class Expires
class Forwarded
class From
class Host
trait IfMatch
object Any.type
class ETags
trait IfNoneMatch
object Any.type
class ETags
trait IfRange
class DateTime
class ETag
class LastModified
class Link
class Location
class MaxForwards
trait Origin
object Null.type
class Value
trait Pragma
object NoCache.type
trait Range
class Multiple
class Prefix
class Single
class Suffix
class Referer
trait RetryAfter
class ByDate
class ByDuration
class Extensions
class Token
class Server
class SetCookie
trait Te
class Compress
class Deflate
class GZip
class Multiple
object Trailers.type
class Trailer
object Chunked.type
object Compress.type
object Deflate.type
object GZip.type
class Multiple
trait Upgrade
class Multiple
class Protocol
trait UserAgent
class Comment
class Complete
class Product
trait Vary
class Headers
object Star.type
trait Via
class Detailed
class Multiple
class Basic
class Bearer
class Digest
class HOBA
class Mutual
class Negotiate
class SCRAM
class Unknown
class Warning
object Deny.type
object SameOrigin.type
Show all
object Header

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Header.type
sealed trait Headers extends Iterable[Header]

Represents an immutable collection of headers. It extends HeaderExtensions and has a ton of powerful operators that can be used to add, remove and modify headers.

Represents an immutable collection of headers. It extends HeaderExtensions and has a ton of powerful operators that can be used to add, remove and modify headers.

NOTE: Generic operators that are not specific to Headers should not be defined here. A better place would be one of the traits extended by HeaderExtension.

Attributes

Companion
object
Supertypes
trait Iterable[Header]
trait IterableFactoryDefaults[Header, Iterable]
trait IterableOps[Header, Iterable, Iterable[Header]]
trait IterableOnceOps[Header, Iterable, Iterable[Header]]
trait IterableOnce[Header]
class Object
trait Matchable
class Any
Show all
Self type
object Headers

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Headers.type
final case class HttpApp[-Env](routes: Routes[Env, Response]) extends PartialFunction[Request, ZIO[Env, Response, Response]]

An HTTP application is a collection of routes, all of whose errors have been handled through conversion into HTTP responses.

An HTTP application is a collection of routes, all of whose errors have been handled through conversion into HTTP responses.

HTTP applications can be installed into a zio.http.Server, which is capable of using them to serve requests.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait PartialFunction[Request, ZIO[Env, Response, Response]]
trait Request => ZIO[Env, Response, Response]
class Object
trait Matchable
class Any
Show all
Self type
HttpApp[Env]
object HttpApp

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
HttpApp.type
trait MdInterpolator

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class MediaType(mainType: String, subType: String, compressible: Boolean, binary: Boolean, fileExtensions: List[String], extensions: Map[String, String], parameters: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MediaType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
MediaType.type
sealed trait Method

Represents an HTTP method, such as GET, PUT, POST, or DELETE.

Represents an HTTP method, such as GET, PUT, POST, or DELETE.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ANY.type
object CONNECT.type
class CUSTOM
object DELETE.type
object GET.type
object HEAD.type
object OPTIONS.type
object PATCH.type
object POST.type
object PUT.type
object TRACE.type
Show all
Self type
object Method

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Method.type
trait Middleware[-UpperEnv]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class HandlerAspect[Env, CtxOut]
Self type
Middleware[UpperEnv]
object Middleware

Attributes

Companion
trait
Supertypes
trait HeaderModifier[HandlerAspect[Any, Unit]]
class Object
trait Matchable
class Any
Self type
Middleware.type
final case class Path

Path is an immutable representation of the path of a URL. Internally it stores each element of a path in a sequence of text, together with flags on whether there are leading and trailing slashes in the path. This allows for a combination of precision and performance and supports a rich API.

Path is an immutable representation of the path of a URL. Internally it stores each element of a path in a sequence of text, together with flags on whether there are leading and trailing slashes in the path. This allows for a combination of precision and performance and supports a rich API.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object Path

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Path.type
sealed trait ProtocolStack[-Env, -IncomingIn, +IncomingOut, -OutgoingIn, +OutgoingOut]

A zio.http.ProtocolStack represents a linear stack of protocol layers, each of which can statefully transform incoming and outgoing values of some handler.

A zio.http.ProtocolStack represents a linear stack of protocol layers, each of which can statefully transform incoming and outgoing values of some handler.

Protocol stacks can be thought of as a formal model of the process of transforming one handler into another handler.

Protocol stacks are designed to support precise semantics around error handling. In particular, if a layer successfully processes an incoming value of a handler, then that same layer will also have a chance to process the outgoing value of the handler. This requirement constrains the ways in which layers can fail, and the types of handlers they may be applied to.

In particular, protocol stacks can be applied to handlers that fail with the same type as their output type. This guarantees that should a handler fail, it will still produce an outgoing value that can be processed by all the layers that successfully transformed the incoming value.

Further, a layer may only fail while it processes an incoming value, and it may only value with the same type as its outgoing value. This guarantees that should a layer fail, it will still produce an outgoing value that can be processed by all the earlier layers that successfully transformed the incoming value.

In a way, the entire design of protocol stacks is geared at ensuring layers that successfully process incoming values will also have a chance to process outgoing values.

The only composition operator on protocol stacks is ++, which simply chains two stacks together. This operator is associative and has an identity (which is the protocol stack that neither transforms incoming nor outgoing values, and which acts as an identity when used to transform handlers).

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
ProtocolStack[Env, IncomingIn, IncomingOut, OutgoingIn, OutgoingOut]
object ProtocolStack

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Proxy(url: URL, credentials: Option[Credentials], headers: Headers)

Represents the connection to the forward proxy before running the request

Represents the connection to the forward proxy before running the request

Value parameters

credentials:

credentials for the proxy server. Encodes credentials with basic auth and put under the 'proxy-authorization' header

headers:

headers for the request to the proxy server

url:

url address of the proxy server

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object Proxy

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Proxy.type
trait QueryParams

A collection of query parameters.

A collection of query parameters.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Show all
Self type
object QueryParams

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait QueryParamsError extends Exception, NoStackTrace

Attributes

Companion
object
Supertypes
trait NoStackTrace
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class Malformed
class Missing
object QueryParamsError

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Request(version: Version, method: Method, url: URL, headers: Headers, body: Body, remoteAddress: Option[InetAddress])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object Request

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Request.type
final class RequestHandlerInput[A, I](val zippable: Out[A, Request, I])

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object RequestHandlerInput

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final case class Response(status: Status, headers: Headers, body: Body)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object Response

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Response.type
sealed trait Route[-Env, +Err]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
Route[Env, Err]
object Route

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Route.type
abstract class RouteDecode[A](f: String => A)

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class RoutePattern[A](method: Method, pathCodec: PathCodec[A])

A pattern for matching routes that examines both HTTP method and path. In addition to specifying a method, patterns contain segment patterns, which are sequences of literals, integers, longs, and other segment types.

A pattern for matching routes that examines both HTTP method and path. In addition to specifying a method, patterns contain segment patterns, which are sequences of literals, integers, longs, and other segment types.

Typically, your entry point constructor for a route pattern would be zio.http.Method:

import zio.http.Method
import zio.http.codec.SegmentCodec._

val pattern = Method.GET / "users" / int("user-id") / "posts" / string("post-id")

However, you can use the convenience constructors in RoutePattern, such as RoutePattern.GET.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object RoutePattern

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final class Routes[-Env, +Err]

Represents a collection of routes, each of which is defined by a pattern and a handler. This data type can be thought of as modeling a routing table, which decides where to direct every endpoint in an API based on both method and path of the request.

Represents a collection of routes, each of which is defined by a pattern and a handler. This data type can be thought of as modeling a routing table, which decides where to direct every endpoint in an API based on both method and path of the request.

When you are done building a collection of routes, you typically convert the routes into an zio.http.HttpApp value, which can be done with the toHttpApp method.

Routes may have handled or unhandled errors. A route of type Route[Env, Throwable], for example, has not handled its errors by converting them into responses. Such unfinished routes cannot yet be converted into zio.http.HttpApp values. First, you must handle errors with the handleError or handleErrorCause methods.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
Routes[Env, Err]
object Routes

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Routes.type
final case class SSLConfig(behaviour: HttpBehaviour, data: Data, provider: Provider, clientAuth: Option[ClientAuth])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SSLConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
SSLConfig.type
sealed trait Scheme

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Custom
object HTTP.type
object HTTPS.type
object WS.type
object WSS.type
Self type
object Scheme

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Scheme.type
trait Server

Represents a server, which is capable of serving zero or more HTTP applications.

Represents a server, which is capable of serving zero or more HTTP applications.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Server extends ServerPlatformSpecific

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Server.type
trait ServerPlatformSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Server.type
final case class ServerSentEvent(data: String, eventType: Option[String], id: Option[String], retry: Option[Int])

Server-Sent Event (SSE) as defined by https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events

Server-Sent Event (SSE) as defined by https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events

Value parameters

data

data, may span multiple lines

eventType

optional type, must not contain \n or \r

id

optional id, must not contain \n or \r

retry

optional reconnection delay in milliseconds

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServerSentEvent

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class SocketDecoder(maxFramePayloadLength: Int, expectMaskedFrames: Boolean, allowMaskMismatch: Boolean, allowExtensions: Boolean, closeOnProtocolViolation: Boolean, withUTF8Validator: Boolean)

Frame decoder configuration

Frame decoder configuration

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object SocketDecoder

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Status extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Custom
trait Error
trait ClientError
object BadRequest.type
object Conflict.type
object ExpectationFailed.type
object FailedDependency.type
object Forbidden.type
object Gone.type
object LengthRequired.type
object Locked.type
object MethodNotAllowed.type
object MisdirectedRequest.type
object NotAcceptable.type
object NotFound.type
object PaymentRequired.type
object PreconditionFailed.type
object PreconditionRequired.type
object RequestEntityTooLarge.type
object RequestTimeout.type
object RequestUriTooLong.type
object TooManyRequests.type
object Unauthorized.type
object UnorderedCollection.type
object UnprocessableEntity.type
object UnsupportedMediaType.type
object UpgradeRequired.type
trait ServerError
object BadGateway.type
object GatewayTimeout.type
object InsufficientStorage.type
object InternalServerError.type
object NotExtended.type
object NotImplemented.type
object ServiceUnavailable.type
object VariantAlsoNegotiates.type
object Continue.type
object Processing.type
object SwitchingProtocols.type
trait Redirection
object Found.type
object MovedPermanently.type
object MultipleChoices.type
object NotModified.type
object PermanentRedirect.type
object SeeOther.type
object TemporaryRedirect.type
object UseProxy.type
trait Success
object Accepted.type
object Created.type
object MultiStatus.type
object NoContent.type
object Ok.type
object PartialContent.type
object ResetContent.type
Show all
Self type
object Status

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Status.type
final case class StreamingForm(source: ZStream[Any, Throwable, Byte], boundary: Boundary, bufferSize: Int)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StreamingForm

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ToHandler[H]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ToHandler

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ToHandler.type
final case class URL(path: Path, kind: Location, queryParams: QueryParams, fragment: Option[Fragment]) extends URLPlatformSpecific

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait QueryChecks[URL]
trait QueryGetters[URL]
class Object
trait Matchable
class Any
Show all
Self type
URL
object URL

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
URL.type
trait URLPlatformSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class URL
Self type
URL
trait UrlInterpolator

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait Version

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Default.type
object Http_1_0.type
object Http_1_1.type
Self type
object Version

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Version.type
final case class WebSocketApp[-R](handler: Handler[R, Throwable, WebSocketChannel, Any], customConfig: Option[WebSocketConfig])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object WebSocketApp

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class WebSocketConfig(subprotocols: Option[String], handshakeTimeoutMillis: Long, forceCloseTimeoutMillis: Long, handleCloseFrames: Boolean, sendCloseFrame: CloseStatus, dropPongFrames: Boolean, decoderConfig: SocketDecoder)

Server side websocket configuration

Server side websocket configuration

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object WebSocketConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait WebSocketFrame extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Binary
class Close
class Continuation
object Ping.type
object Pong.type
class Text
Show all
Self type
object WebSocketFrame

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZClient[-Env, -In, +Err, +Out](version: Version, url: URL, headers: Headers, sslConfig: Option[ClientSSLConfig], proxy: Option[Proxy], bodyEncoder: BodyEncoder[Env, Err, In], bodyDecoder: BodyDecoder[Env, Err, Out], driver: Driver[Env, Err])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait HeaderChecks[ZClient[Env, In, Err, Out]]
trait HeaderModifier[ZClient[Env, In, Err, Out]]
class Object
trait Matchable
class Any
Show all
Self type
ZClient[Env, In, Err, Out]
object ZClient extends ZClientPlatformSpecific

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
ZClient.type
trait ZClientAspect[+LowerEnv, -UpperEnv, +LowerIn, -UpperIn, +LowerErr, -UpperErr, +LowerOut, -UpperOut]

A ZClientAspect is capable on modifying some aspect of the execution of a client, such as metrics, tracing, encoding, decoding, or logging.

A ZClientAspect is capable on modifying some aspect of the execution of a client, such as metrics, tracing, encoding, decoding, or logging.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
ZClientAspect[LowerEnv, UpperEnv, LowerIn, UpperIn, LowerErr, UpperErr, LowerOut, UpperOut]
object ZClientAspect

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait ZClientPlatformSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ZClient.type
trait ZCompose[+LeftLower, -LeftUpper, LeftOut[In], +RightLower, -RightUpper, RightOut[In]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZCompose extends ComposeLowPriorityImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ZCompose.type

Types

type Client = ZClient[Any, Body, Throwable, Response]
type RequestHandler[-R, +Err] = Handler[R, Err, Request, Response]
type WebSocketChannel = Channel[WebSocketChannelEvent, WebSocketChannelEvent]

A channel that allows websocket frames to be written to it.

A channel that allows websocket frames to be written to it.

Attributes

type WebSocketChannelEvent = ChannelEvent[WebSocketFrame]

A channel that allows websocket frames to be read and write to it.

A channel that allows websocket frames to be read and write to it.

Attributes

Value members

Concrete methods

def Client: ZClient.type
def boolean(name: String): PathCodec[Boolean]
def handler[H](handler: => H)(implicit h: ToHandler[H]): Handler[Env, Err, In, Out]

A smart constructor that attempts to construct a handler from the specified value. If you have difficulty using this function, then please use the constructors on zio.http.Handler directly.

A smart constructor that attempts to construct a handler from the specified value. If you have difficulty using this function, then please use the constructors on zio.http.Handler directly.

Attributes

def handlerTODO(message: String): Handler[Any, Nothing, Any, Nothing]
def int(name: String): PathCodec[Int]
def long(name: String): PathCodec[Long]
def string(name: String): PathCodec[String]
def uuid(name: String): PathCodec[UUID]

Concrete fields

val Empty: Path
val Root: Path

Extensions

Inherited extensions

extension (inline sc: StringContext)
inline def url(inline args: Any*): URL

Attributes

Inherited from:
UrlInterpolator
extension (inline sc: StringContext)
inline def md(inline args: Any*): Doc

Attributes

Inherited from:
MdInterpolator
Generated with