zio.http
Members list
Type members
Classlikes
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- class ExceptionCaughtclass Read[A]object Registered.typeobject Unregistered.typeclass UserEventTriggered
- Self type
- ChannelEvent[A]
Attributes
- Companion:
- trait
- Graph
- Supertypes
- Self type
- ChannelEvent.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- class NettyClientDriver
Attributes
- Companion:
- trait
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- ClientDriver.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- object Default.typeclass FromCertFileclass FromCertResourceclass FromTrustStoreFileclass FromTrustStoreResource
Attributes
- Companion:
- trait
- Graph
- Supertypes
- Self type
- ClientSSLConfig.type
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- object ZCompose.type
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- trait NettyConnectionPool
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion:
- trait
- Graph
- Supertypes
- Self type
- ConnectionPoolConfig.type
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- Self type
Attributes
- Companion:
- trait
- Graph
- Supertypes
- Self type
- Decompression.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Companion:
- trait
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- DnsResolver.type
Path is an immutable representation of a urls path. Internally it stores each
element of a path in a sequence of Segment
. This allows for powerful
compositional APIs.
Path is an immutable representation of a urls path. Internally it stores each
element of a path in a sequence of Segment
. This allows for powerful
compositional APIs.
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- class IntExtractor
Represents a form decoding error.
Represents a form decoding error.
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass Any
- Known subtypes
- object BoundaryNotFoundInContent.typeobject ContentDispositionMissingName.typeobject FormDataMissingContentDisposition.typeclass InvalidCharsetclass InvalidURLEncodedFormat
- Self type
Attributes
- Companion:
- trait
- Graph
- Supertypes
- Self type
- FormDecodingError.type
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- HandlerAspect.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- class Accepttrait AcceptEncodingclass Brclass Compressclass Deflateclass GZipclass Identityclass Multipleclass NoPreferencetrait AcceptLanguageobject Any.typeclass Multipleclass Singleclass AcceptPatchtrait AcceptRangesobject Bytes.typeobject None.typeobject Allow.typeobject DoNotAllow.typeobject All.typeobject None.typeclass Someobject All.typeobject None.typeclass Sometrait AccessControlAllowOriginobject All.typeclass Specificobject All.typeobject None.typeclass Someclass AccessControlMaxAgeclass Ageclass Allowtrait Authorizationclass Basicclass Bearerclass Digestclass Unparsedtrait CacheControlobject Immutable.typeclass MaxAgeclass MaxStaleclass MinFreshclass Multipleobject MustRevalidate.typeobject MustUnderstand.typeobject NoCache.typeobject NoStore.typeobject NoTransform.typeobject OnlyIfCached.typeobject Private.typeobject ProxyRevalidate.typeobject Public.typeclass SMaxAgeclass StaleIfErrorclass StaleWhileRevalidatetrait Connectionobject Close.typeobject KeepAlive.typeclass ContentBasetrait ContentDispositionclass Attachmentclass FormFieldclass Inlinetrait ContentEncodingobject Br.typeobject Compress.typeobject Deflate.typeobject GZip.typeclass Multipletrait ContentLanguageobject Arabic.typeobject Bulgarian.typeobject Catalan.typeobject Chinese.typeobject Croatian.typeobject Czech.typeobject Danish.typeobject Dutch.typeobject English.typeobject Estonian.typeobject Finnish.typeobject French.typeobject German.typeobject Greek.typeobject Hebrew.typeobject Hindi.typeobject Hungarian.typeobject Icelandic.typeobject Indonesian.typeobject Italian.typeobject Japanese.typeobject Korean.typeobject Latvian.typeobject Lithuanian.typeobject Norwegian.typeobject Polish.typeobject Portuguese.typeobject Romanian.typeobject Russian.typeobject Serbian.typeobject Slovak.typeobject Slovenian.typeobject Spanish.typeobject Swedish.typeobject Thai.typeobject Turkish.typeobject Ukrainian.typeobject Vietnamese.typeclass ContentLengthclass ContentLocationclass ContentMd5trait ContentRangeclass EndTotalclass RangeTotalclass StartEndtrait ContentSecurityPolicyobject BlockAllMixedContent.typeclass PluginTypesclass Referrerclass ReportToclass ReportUriclass RequireSriForclass Sandboxclass SourcePolicyclass TrustedTypesobject UpgradeInsecureRequests.typetrait ContentTransferEncodingobject Base64.typeobject Binary.typeobject EightBit.typeobject QuotedPrintable.typeobject SevenBit.typeclass XTokenclass ContentTypeclass Cookieclass Customtrait DNTobject NotSpecified.typeobject TrackingAllowed.typeobject TrackingNotAllowed.typeclass Datetrait ETagclass Strongclass Weaktrait Expectobject 100-continue.typeclass Expiresclass Fromclass Hosttrait IfMatchobject Any.typeclass ETagsclass IfModifiedSincetrait IfNoneMatchobject Any.typeclass ETagstrait IfRangeclass DateTimeclass ETagclass IfUnmodifiedSinceclass LastModifiedclass Locationclass MaxForwardstrait Originobject Null.typeclass Valuetrait Pragmaobject NoCache.typeclass ProxyAuthenticateclass ProxyAuthorizationtrait Rangeclass Multipleclass Prefixclass Singleclass Suffixclass Referertrait RetryAfterclass ByDateclass ByDurationclass SecWebSocketAccepttrait SecWebSocketExtensionsclass Extensionsclass Tokenclass SecWebSocketKeyclass SecWebSocketLocationclass SecWebSocketOriginclass SecWebSocketProtocolclass SecWebSocketVersionclass Serverclass SetCookietrait Teclass Compressclass Deflateclass GZipclass Multipleobject Trailers.typeclass Trailertrait TransferEncodingobject Chunked.typeobject Compress.typeobject Deflate.typeobject GZip.typeclass Multipletrait Upgradeclass Multipleclass Protocolclass UpgradeInsecureRequeststrait UserAgentclass Commentclass Completeclass Producttrait Varyclass Headersobject Star.typetrait Viaclass Detailedclass Multipletrait WWWAuthenticateclass AWS4-HMAC-SHA256class Basicclass Bearerclass Digestclass HOBAclass Mutualclass Negotiateclass SCRAMclass Unknownclass Warningtrait XFrameOptionsobject Deny.typeobject SameOrigin.typeclass XRequestedWith
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
- Graph
- Supertypes
- trait IterableOnce[Header]trait HeaderChecks[Headers]trait HeaderGetterstrait HeaderModifier[Headers]class Objecttrait Matchableclass Any
- Self type
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- HttpAppMiddleware.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Throwabletrait Serializableclass Objecttrait Matchableclass Any
- Known subtypes
- class BadGatewayclass BadRequestclass Conflictclass Customclass ExpectationFailedclass FailedDependencyclass Forbiddenclass GatewayTimeoutclass Goneclass HTTPErrorWithCauseclass InternalServerErrorclass HttpVersionNotSupportedclass InsufficientStorageclass LengthRequiredclass Lockedclass MethodNotAllowedclass MisdirectedRequestclass NotAcceptableclass NotExtendedclass NotFoundclass NotImplementedclass PaymentRequiredclass PreconditionFailedclass PreconditionRequiredclass RequestEntityTooLargeclass RequestTimeoutclass RequestUriTooLongclass ServiceUnavailableclass TooManyRequestsclass Unauthorizedclass UnorderedCollectionclass UnprocessableEntityclass UnsupportedMediaTypeclass UpgradeRequiredclass VariantAlsoNegotiates
- Self type
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- Self type
Represents the connection to the forward proxy before running the request
Represents the connection to the forward proxy before running the request
Attributes
- 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
- Companion:
- object
- Graph
- Supertypes
- Self type
A collection of query parameters.
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- QueryParams.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalstrait HeaderChecks[Request]trait HeaderGetterstrait HeaderModifier[Request]class Objecttrait Matchableclass Any
- Self type
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
Attributes
- Companion:
- object
- Graph
- Supertypes
- trait HeaderChecks[Response]trait HeaderGetterstrait HeaderModifier[Response]class Objecttrait Matchableclass Any
- Self type
Instead of using just String
as path params, using the RouteDecoderModule
we can extract and converted params into a specific type also.
Instead of using just String
as path params, using the RouteDecoderModule
we can extract and converted params into a specific type also.
Http.collect[Request] {
case GET -> Root / "user" / int(id) => Response.text("User id requested: ${id}")
case GET -> Root / "user" / name => Response.text("User name requested: ${name}")
}
If the request looks like GET /user/100
then it would match the first case.
This is because internally the id
param can be decoded into an Int
. If a
request of the form GET /user/zio
is made, in that case the second case is
matched.
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
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
Attributes
- 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
- Companion:
- object
- Graph
- Supertypes
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- ServerSentEvent.type
Frame decoder configuration
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- SocketDecoder.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
- object Accepted.typeobject BadGateway.typeobject BadRequest.typeobject Conflict.typeobject Continue.typeobject Created.typeclass Customobject ExpectationFailed.typeobject FailedDependency.typeobject Forbidden.typeobject Found.typeobject GatewayTimeout.typeobject Gone.typeobject HttpVersionNotSupported.typeobject InsufficientStorage.typeobject InternalServerError.typeobject LengthRequired.typeobject Locked.typeobject MethodNotAllowed.typeobject MisdirectedRequest.typeobject MovedPermanently.typeobject MultiStatus.typeobject MultipleChoices.typeobject NetworkAuthenticationRequired.typeobject NoContent.typeobject NonAuthoritativeInformation.typeobject NotAcceptable.typeobject NotExtended.typeobject NotFound.typeobject NotImplemented.typeobject NotModified.typeobject Ok.typeobject PartialContent.typeobject PaymentRequired.typeobject PermanentRedirect.typeobject PreconditionFailed.typeobject PreconditionRequired.typeobject Processing.typeobject ProxyAuthenticationRequired.typeobject RequestEntityTooLarge.typeobject RequestHeaderFieldsTooLarge.typeobject RequestTimeout.typeobject RequestUriTooLong.typeobject RequestedRangeNotSatisfiable.typeobject ResetContent.typeobject SeeOther.typeobject ServiceUnavailable.typeobject SwitchingProtocols.typeobject TemporaryRedirect.typeobject TooManyRequests.typeobject Unauthorized.typeobject UnorderedCollection.typeobject UnprocessableEntity.typeobject UnsupportedMediaType.typeobject UpgradeRequired.typeobject UseProxy.typeobject VariantAlsoNegotiates.type
- Self type
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- StreamingForm.type
Server side websocket configuration
Attributes
- Companion:
- class
- Graph
- Supertypes
- Self type
- WebSocketConfig.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
- Self type
Attributes
- Companion:
- trait
- Graph
- Supertypes
- Self type
- WebSocketFrame.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- Self type
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
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
Attributes
- Companion:
- trait
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- ZClientAspect.type
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
Inherited classlikes
Attributes
- Inherited from:
- RequestSyntax (hidden)
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- PathSyntax (hidden)
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- PathSyntax (hidden)
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Attributes
- Inherited from:
- RouteDecoderModule
- Graph
- Supertypes
Types
A channel that allows websocket frames to be written to it.
A channel that allows websocket frames to be written to it.
Attributes
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.