zio-http
zio-http
API
zio.http
codec
internal
HaltException
Alternator
Alternator
AlternatorLowPriority1
AlternatorLowPriority2
AlternatorLowPriority3
Combiner
Combiner
CombinerLowPriority1
CombinerLowPriority2
CombinerLowPriority3
CombinerLowPriority4
CombinerLowPriority5
CombinerLowPriority6
ContentCodec
Doc
Doc
DescriptionList
Empty
Header
Listing
ListingType
Ordered
Unordered
ListingType
Paragraph
Sequence
Span
Bold
Code
CodeStyle
Block
Inline
CodeStyle
Error
Italic
Link
Sequence
Text
Span
HeaderCodec
HttpCodec
HttpCodec
Enumeration
Metadata
Deprecated
Documented
Examples
Named
Optional
Metadata
HttpCodecError
HttpCodecError
CustomError
InvalidEntity
InvalidEntity
MalformedBody
MalformedHeader
MalformedMethod
MalformedPath
MalformedQueryParam
MalformedStatus
MissingHeader
MissingQueryParam
PathTooShort
UnsupportedContentType
HttpCodecType
HttpCodecType
HttpContentCodec
HttpContentCodec
json
protobuf
text
MethodCodec
PathCodec
PathCodec
Annotated
MetaData
Documented
Examples
MetaData
SegmentSubtree
QueryCodec
RichTextCodec
RichTextCodec
Lazy
SegmentCodec
SegmentCodec
Trailing
SimpleCodec
SimpleCodec
Specified
Unspecified
StatusCodec
TextCodec
TextCodec
BooleanCodec
Constant
IntCodec
LongCodec
StringCodec
UUIDCodec
endpoint
openapi
JsonSchema
JsonSchema
AllOfSchema
AnnotatedSchema
AnyJson
AnyOfSchema
ArrayType
Boolean
ContentEncoding
Base16
Base32
Base64
Binary
EightBit
QuotedPrintable
SevenBit
ContentEncoding
Enum
EnumValue
Bool
Null
Num
SchemaValue
Str
EnumValue
Integer
IntegerFormat
Int32
Int64
Timestamp
IntegerFormat
MetaData
ContentEncoding
ContentMediaType
Default
Deprecated
Description
Discriminator
Examples
Nullable
MetaData
Null
Number
NumberFormat
Double
Float
NumberFormat
Object
Object
OneOfSchema
Pattern
RefSchema
SchemaStyle
Compact
Inline
Reference
SchemaStyle
String
String
StringFormat
Custom
Date
DateTime
Duration
Email
Hostname
IPv4
IPv6
IRI
IRIReference
IdnEmail
IdnHostname
JSONPointer
Password
Regex
RelativeJSONPointer
Time
URI
URIRef
URITemplate
UUID
StringFormat
JsonSchemas
OpenAPI
OpenAPI
Callback
Callback
Components
Contact
Discriminator
Discriminator
Encoding
Encoding
Example
Example
ExternalDoc
Header
Header
Info
Key
Key
License
Link
Link
LiteralOrExpression
BooleanLiteral
BooleanLiteral
DecimalLiteral
DecimalLiteral
Expression
Expression
NumberLiteral
NumberLiteral
StringLiteral
StringLiteral
LiteralOrExpression
MediaType
MediaType
Operation
Parameter
Parameter
Content
PathStyle
QueryStyle
Style
DeepObject
Form
Label
Matrix
PipeDelimited
Simple
SpaceDelimited
Path
Path
PathItem
PathItem
ReferenceOr
Or
Or
Reference
Reference
ReferenceOr
RequestBody
RequestBody
Response
Response
SecurityScheme
ApiKey
ApiKey
In
Cookie
Header
Query
In
Http
OAuth2
OAuthFlow
AuthorizationCode
ClientCredentials
Implicit
Password
OAuthFlow
OAuthFlows
OpenIdConnect
SecurityRequirement
SecurityScheme
Server
ServerVariable
ServerVariable
StatusOrDefault
Default
StatusValue
StatusValue
StatusOrDefault
Tag
XML
OpenAPIGen
AtomizedMetaCodecs
AtomizedMetaCodecs
MetaCodec
SwaggerUI
Endpoint
Endpoint
OutErrors
EndpointExecutor
EndpointExecutor
Config
Config
EndpointLocator
EndpointLocator
EndpointMiddleware
EndpointMiddleware
None
Spec
EndpointNotFound
Invocation
internal
BodyEncoding
BodyEncoding
BodyEncodingPlatformSpecific
CaseMode
CaseMode
Insensitive
Sensitive
ChannelState
ChannelState
Invalid
Reusable
FetchBody
FetchBody
FetchDriver
FetchDriver
HeaderChecks
HeaderGetters
HeaderModifier
QueryChecks
QueryGetters
QueryModifier
template
Attributes
Attributes
PartialAttribute
Dom
Dom
Element
PartialElement
Elements
EncodingState
Indentation
NoIndentation
Html
Html
IsAttributeValue
IsAttributeValue
Template
Body
Body
Boundary
Boundary
Channel
ChannelEvent
ChannelEvent
ExceptionCaught
Read
Registered
Unregistered
UserEvent
HandshakeComplete
HandshakeTimeout
UserEvent
UserEventTriggered
Charsets
ClientAuth
ClientAuth
NoneClientAuth
Optional
Required
ClientDriver
ClientDriver
ChannelInterface
ClientSSLConfig
ClientSSLConfig
Default
FromCertFile
FromCertResource
FromTrustStoreFile
FromTrustStoreFile
FromTrustStoreResource
FromTrustStoreResource
ComposeLowPriorityImplicits
ConnectionPool
ConnectionPoolConfig
ConnectionPoolConfig
Disabled
Dynamic
DynamicPerHost
Fixed
FixedPerHost
Cookie
Cookie
Request
Request
Response
Response
SameSite
Lax
None
Strict
SameSite
Credentials
Decompression
Decompression
No
NonStrict
Strict
DnsResolver
DnsResolver
Config
Config
ExpireAction
Drop
Refresh
ExpireAction
Driver
Driver
StartResult
DriverPlatformSpecific
Flash
Flash
Backend
Backend
Message
Setter
Form
Form
FormDecodingError
FormDecodingError
BoundaryNotFoundInContent
ContentDispositionMissingName
FormDataMissingContentDisposition
FormDecodingException
InvalidCharset
InvalidURLEncodedFormat
FormField
FormField
Binary
Simple
StreamingBinary
Text
Handler
Handler
ContraFlatMap
FromFunction
FromFunctionExit
FromFunctionHandler
FromFunctionZIO
IsRequest
IsRequest
ParamExtractorBuilder
RequestHandlerSyntax
ResponseOutputSyntax
HandlerAspect
HandlerAspect
Allow
AllowZIO
InterceptPatch
InterceptPatchZIO
HandlerPlatformSpecific
Header
Header
Accept
Accept
MediaTypeWithQFactor
AcceptEncoding
Br
Compress
Deflate
GZip
Identity
Multiple
NoPreference
Unknown
AcceptEncoding
AcceptLanguage
Any
Multiple
Single
AcceptLanguage
AcceptPatch
AcceptPatch
AcceptRanges
Bytes
None
AcceptRanges
AccessControlAllowCredentials
Allow
DoNotAllow
AccessControlAllowCredentials
AccessControlAllowHeaders
All
None
Some
AccessControlAllowHeaders
AccessControlAllowMethods
All
None
Some
AccessControlAllowMethods
AccessControlAllowOrigin
All
Specific
AccessControlAllowOrigin
AccessControlExposeHeaders
All
None
Some
AccessControlExposeHeaders
AccessControlMaxAge
AccessControlMaxAge
AccessControlRequestHeaders
AccessControlRequestHeaders
AccessControlRequestMethod
AccessControlRequestMethod
Age
Age
Allow
Allow
AuthenticationScheme
AWS4-HMAC-SHA256
Basic
Bearer
Digest
HOBA
Mutual
Negotiate
OAuth
Scram
ScramSha1
ScramSha256
Vapid
AuthenticationScheme
Authorization
Basic
Basic
Bearer
Bearer
Digest
Unparsed
Unparsed
Authorization
CacheControl
Immutable
MaxAge
MaxStale
MinFresh
Multiple
MustRevalidate
MustUnderstand
NoCache
NoStore
NoTransform
OnlyIfCached
Private
ProxyRevalidate
Public
SMaxAge
StaleIfError
StaleWhileRevalidate
CacheControl
ClearSiteData
ClearSiteData
ClearSiteDataDirective
All
Cache
ClientHints
Cookies
ExecutionContexts
Storage
ClearSiteDataDirective
Connection
Close
KeepAlive
Connection
ContentBase
ContentBase
ContentDisposition
Attachment
FormField
Inline
ContentDisposition
ContentEncoding
Br
Compress
Deflate
GZip
Multiple
ContentEncoding
ContentLanguage
Arabic
Bulgarian
Catalan
Chinese
Croatian
Czech
Danish
Dutch
English
Estonian
Finnish
French
German
Greek
Hebrew
Hindi
Hungarian
Icelandic
Indonesian
Italian
Japanese
Korean
Latvian
Lithuanian
Norwegian
Polish
Portuguese
Romanian
Russian
Serbian
Slovak
Slovenian
Spanish
Swedish
Thai
Turkish
Ukrainian
Vietnamese
ContentLanguage
ContentLength
ContentLength
ContentLocation
ContentLocation
ContentMd5
ContentMd5
ContentRange
EndTotal
RangeTotal
StartEnd
ContentRange
ContentSecurityPolicy
BlockAllMixedContent
PluginTypes
Referrer
ReferrerPolicy
no-referrer
none-when-downgrade
origin
origin-when-cross-origin
unsafe-url
ReferrerPolicy
ReportTo
ReportUri
RequireSriFor
RequireSriForValue
Script
ScriptStyle
Style
RequireSriForValue
Sandbox
SandboxValue
AllowForms
AllowModals
AllowOrientationLock
AllowPointerLock
AllowPopups
AllowPopupsToEscapeSandbox
AllowPresentation
AllowSameOrigin
AllowScripts
AllowTopNavigation
Empty
Sequence
SandboxValue
Source
Hash
HashAlgorithm
Sha256
Sha384
Sha512
HashAlgorithm
Host
Nonce
ReportSample
Scheme
Self
Sequence
StrictDynamic
UnsafeEval
UnsafeHashes
UnsafeInline
WasmUnsafeEval
none
Source
SourcePolicy
SourcePolicyType
base-uri
child-src
connect-src
default-src
font-src
form-action
frame-ancestors
frame-src
img-src
manifest-src
media-src
object-src
prefetch-src
script-src
script-src-attr
script-src-elem
style-src
style-src-attr
style-src-elem
upgrade-insecure-requests
worker-src
SourcePolicyType
TrustedTypes
TrustedTypesValue
PolicyName
Sequence
Wildcard
allow-duplicates
none
TrustedTypesValue
UpgradeInsecureRequests
ContentSecurityPolicy
ContentTransferEncoding
Base64
Binary
EightBit
QuotedPrintable
SevenBit
XToken
ContentTransferEncoding
ContentType
ContentType
Cookie
Cookie
Custom
DNT
NotSpecified
TrackingAllowed
TrackingNotAllowed
DNT
Date
Date
ETag
Strong
Weak
ETag
Expect
100-continue
Expect
Expires
Expires
Forwarded
Forwarded
From
From
HeaderType
HeaderType
Host
Host
IfMatch
Any
ETags
IfMatch
IfModifiedSince
IfModifiedSince
IfNoneMatch
Any
ETags
IfNoneMatch
IfRange
DateTime
ETag
IfRange
IfUnmodifiedSince
IfUnmodifiedSince
LastModified
LastModified
Link
Link
Location
Location
MaxForwards
MaxForwards
Origin
Null
Value
Origin
Pragma
NoCache
Pragma
ProxyAuthenticate
ProxyAuthenticate
ProxyAuthorization
ProxyAuthorization
Range
Multiple
Prefix
Single
Suffix
Range
Referer
Referer
RetryAfter
ByDate
ByDuration
RetryAfter
SecWebSocketAccept
SecWebSocketAccept
SecWebSocketExtensions
Extension
Parameter
TokenParam
Extension
Extensions
Token
SecWebSocketExtensions
SecWebSocketKey
SecWebSocketKey
SecWebSocketLocation
SecWebSocketLocation
SecWebSocketOrigin
SecWebSocketOrigin
SecWebSocketProtocol
SecWebSocketProtocol
SecWebSocketVersion
SecWebSocketVersion
Server
Server
SetCookie
SetCookie
Te
Compress
Deflate
GZip
Multiple
Trailers
Te
Trailer
Trailer
TransferEncoding
Chunked
Compress
Deflate
GZip
Multiple
TransferEncoding
Upgrade
Multiple
Protocol
Upgrade
UpgradeInsecureRequests
UpgradeInsecureRequests
UserAgent
Comment
Complete
Product
UserAgent
Vary
Headers
Star
Vary
Via
Detailed
Multiple
ReceivedProtocol
ProtocolVersion
Version
ReceivedProtocol
Via
WWWAuthenticate
AWS4-HMAC-SHA256
Basic
Bearer
Digest
HOBA
Mutual
Negotiate
SCRAM
Unknown
WWWAuthenticate
Warning
Warning
XFrameOptions
Deny
SameOrigin
XFrameOptions
XRequestedWith
XRequestedWith
Headers
Headers
HttpApp
HttpApp
MdInterpolator
MediaType
MediaType
Method
Method
ANY
CONNECT
CUSTOM
DELETE
GET
HEAD
OPTIONS
PATCH
POST
PUT
TRACE
Middleware
Middleware
CorsConfig
Path
Path
Flag
LeadingSlash
TrailingSlash
Flag
Flags
ProtocolStack
ProtocolStack
CondBuilder
CondZIOBuilder
CondZIOBuilder1
Proxy
Proxy
QueryParams
QueryParams
QueryParamsError
QueryParamsError
Malformed
Missing
Request
Request
Patch
Patch
RequestHandlerInput
RequestHandlerInput
Response
Response
Patch
AddHeaders
Combine
Empty
RemoveHeaders
SetStatus
UpdateHeaders
Patch
Route
Route
Builder
Builder
HandledConstructor
UnhandledConstructor
RouteDecode
RoutePattern
RoutePattern
Routes
Routes
SSLConfig
SSLConfig
Data
FromFile
FromResource
Generate
Data
HttpBehaviour
Accept
Fail
Redirect
HttpBehaviour
Provider
JDK
OpenSSL
Provider
Scheme
Scheme
Custom
HTTP
HTTPS
WS
WSS
Server
Server
Config
Config
CompressionOptions
CompressionOptions
CompressionType
ResponseCompressionConfig
ResponseCompressionConfig
RequestStreaming
Disabled
Enabled
RequestStreaming
ServerPlatformSpecific
ServerSentEvent
ServerSentEvent
SocketDecoder
SocketDecoder
Status
Status
Accepted
BadGateway
BadRequest
ClientError
Conflict
Continue
Created
Custom
Error
ExpectationFailed
FailedDependency
Forbidden
Found
GatewayTimeout
Gone
HttpVersionNotSupported
Informational
InsufficientStorage
InternalServerError
LengthRequired
Locked
MethodNotAllowed
MisdirectedRequest
MovedPermanently
MultiStatus
MultipleChoices
NetworkAuthenticationRequired
NoContent
NonAuthoritativeInformation
NotAcceptable
NotExtended
NotFound
NotImplemented
NotModified
Ok
PartialContent
PaymentRequired
PermanentRedirect
PreconditionFailed
PreconditionRequired
Processing
ProxyAuthenticationRequired
Redirection
RequestEntityTooLarge
RequestHeaderFieldsTooLarge
RequestTimeout
RequestUriTooLong
RequestedRangeNotSatisfiable
ResetContent
SeeOther
ServerError
ServiceUnavailable
Success
SwitchingProtocols
TemporaryRedirect
TooManyRequests
Unauthorized
UnorderedCollection
UnprocessableEntity
UnsupportedMediaType
UpgradeRequired
UseProxy
VariantAlsoNegotiates
StreamingForm
StreamingForm
ZStreamOps
ToHandler
ToHandler
URL
URL
Fragment
Fragment
Location
Absolute
Relative
Location
URLPlatformSpecific
UrlInterpolator
Version
Version
Default
Http_1_0
Http_1_1
WebSocketApp
WebSocketApp
WebSocketConfig
WebSocketConfig
CloseStatus
AbnormalClosure
BadGateway
Custom
Empty
EndpointUnavailable
InternalServerError
InvalidMessageType
InvalidPayloadData
MandatoryExtension
MessageTooBig
NormalClosure
PolicyViolation
ProtocolError
ServiceRestart
TlsHandshakeFailed
TryAgainLater
CloseStatus
WebSocketFrame
WebSocketFrame
Binary
Binary
Close
Continuation
Continuation
Ping
Pong
Text
Text
ZClient
ZClient
BodyDecoder
BodyDecoder
BodyEncoder
BodyEncoder
Config
Config
Driver
ZClientAspect
ZClientAspect
ZClientPlatformSpecific
ZCompose
ZCompose
zio-http
/
zio.http
/
Header
/
Allow
Allow
zio.http.Header.Allow
See the
Allow
companion class
object
Allow
extends
HeaderType
Attributes
Companion
class
Graph
Reset zoom
Hide graph
Show graph
Supertypes
trait
Product
trait
Mirror
trait
HeaderType
class
Object
trait
Matchable
class
Any
Show all
Self type
Allow
.type
Members list
Clear all
Type members
Types
override
type
HeaderValue
=
Allow
Inherited 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
override
def
name
:
String
Attributes
Definition Classes
HeaderType
def
parse
(
value
:
String
):
Either
[
String
,
Allow
]
def
render
(
allow
:
Allow
):
String
Concrete fields
val
CONNECT
:
Allow
val
DELETE
:
Allow
val
GET
:
Allow
val
HEAD
:
Allow
val
OPTIONS
:
Allow
val
PATCH
:
Allow
val
POST
:
Allow
val
PUT
:
Allow
val
TRACE
:
Allow
In this article
Attributes
Members list
Type members
Types
Inherited types
Value members
Concrete methods
Concrete fields