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

Header

zio.http.Header
See theHeader companion trait
object Header

Attributes

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

Members list

Type members

Classlikes

final case class Accept(mimeTypes: NonEmptyChunk[MediaTypeWithQFactor]) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Accept extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Accept.type
object AcceptEncoding extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AcceptEncoding extends Header

Represents an AcceptEncoding header value.

Represents an AcceptEncoding header value.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Br
class Compress
class Deflate
class GZip
class Identity
class Multiple
class NoPreference
class Unknown
Show all
object AcceptLanguage extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AcceptLanguage extends Header

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Any
class Multiple
class Single
final case class AcceptPatch(mediaTypes: NonEmptyChunk[MediaType]) extends Header

The Accept-Patch response HTTP header advertises which media-type the server is able to understand in a PATCH request.

The Accept-Patch response HTTP header advertises which media-type the server is able to understand in a PATCH request.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object AcceptPatch extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object AcceptRanges extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AcceptRanges extends Header

The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads. The value of this field indicates the unit that can be used to define a range. By default the RFC 7233 specification supports only 2 possible values.

The Accept-Ranges HTTP response header is a marker used by the server to advertise its support for partial requests from the client for file downloads. The value of this field indicates the unit that can be used to define a range. By default the RFC 7233 specification supports only 2 possible values.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Bytes
object None
object AccessControlAllowCredentials extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AccessControlAllowCredentials extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Allow
object DoNotAllow
object AccessControlAllowHeaders extends HeaderType

The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.

The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AccessControlAllowHeaders extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object All
object None
class Some
object AccessControlAllowMethods extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AccessControlAllowMethods extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object All
object None
class Some
object AccessControlAllowOrigin extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AccessControlAllowOrigin extends Header

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin.

The Access-Control-Allow-Origin response header indicates whether the response can be shared with requesting code from the given origin.

For requests without credentials, the literal value "*" can be specified as a wildcard; the value tells browsers to allow requesting code from any origin to access the resource. Attempting to use the wildcard with credentials results in an error.

Specifies an origin. Only a single origin can be specified. If the server supports clients from multiple origins, it must return the origin for the specific client making the request.

null Specifies the origin "null".

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object All
class Specific
object AccessControlExposeHeaders extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait AccessControlExposeHeaders extends Header

The Access-Control-Expose-Headers response header allows a server to indicate which response headers should be made available to scripts running in the browser, in response to a cross-origin request.

The Access-Control-Expose-Headers response header allows a server to indicate which response headers should be made available to scripts running in the browser, in response to a cross-origin request.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object All
object None
class Some
final case class AccessControlMaxAge(duration: Duration) extends Header

The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.

The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.

Maximum number of seconds the results can be cached, as an unsigned non-negative integer. Firefox caps this at 24 hours (86400 seconds). Chromium (prior to v76) caps at 10 minutes (600 seconds). Chromium (starting in v76) caps at 2 hours (7200 seconds). The default value is 5 seconds.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object AccessControlMaxAge extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class AccessControlRequestHeaders(values: NonEmptyChunk[String]) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object AccessControlRequestHeaders extends HeaderType

The Access-Control-Request-Headers request header is used by browsers when issuing a preflight request to let the server know which HTTP headers the client might send when the actual request is made (such as with setRequestHeader()). The complementary server-side header of Access-Control-Allow-Headers will answer this browser-side header.

The Access-Control-Request-Headers request header is used by browsers when issuing a preflight request to let the server know which HTTP headers the client might send when the actual request is made (such as with setRequestHeader()). The complementary server-side header of Access-Control-Allow-Headers will answer this browser-side header.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class AccessControlRequestMethod(method: Method) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object AccessControlRequestMethod extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class Age(duration: Duration) extends Header

Age header value.

Age header value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Age extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Age.type
final case class Allow(methods: NonEmptyChunk[Method]) extends Header

The Allow header must be sent if the server responds with a 405 Method Not Allowed status code to indicate which request methods can be used.

The Allow header must be sent if the server responds with a 405 Method Not Allowed status code to indicate which request methods can be used.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Allow extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Allow.type
object AuthenticationScheme

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Basic
object Bearer
object Digest
object HOBA
object Mutual
object Negotiate
object OAuth
object Scram
object ScramSha1
object ScramSha256
object Vapid
Show all
object Authorization extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait Authorization extends Header

Authorization header value.

Authorization header value.

The Authorization header value contains one of the auth schemes

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Basic
class Bearer
class Digest
class Unparsed
object CacheControl extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait CacheControl extends Header

CacheControl header value.

CacheControl header value.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Immutable
class MaxAge
class MaxStale
class MinFresh
class Multiple
object NoCache
object NoStore
object NoTransform
object OnlyIfCached
object Private
object Public
class SMaxAge
class StaleIfError
Show all
final case class ClearSiteData(directives: NonEmptyChunk[ClearSiteDataDirective]) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ClearSiteData extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object ClearSiteDataDirective

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object All
object Cache
object ClientHints
object Cookies
object Storage
Show all
object Connection extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Connection.type
sealed trait Connection extends Header

Connection header value.

Connection header value.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Close
object KeepAlive
final case class ContentBase(uri: URI) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ContentBase extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object ContentDisposition extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ContentDisposition extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Attachment
class FormField
class Inline
object ContentEncoding extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ContentEncoding extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Br
object Compress
object Deflate
object GZip
class Multiple
object ContentLanguage extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ContentLanguage extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Arabic
object Bulgarian
object Catalan
object Chinese
object Croatian
object Czech
object Danish
object Dutch
object English
object Estonian
object Finnish
object French
object German
object Greek
object Hebrew
object Hindi
object Hungarian
object Icelandic
object Indonesian
object Italian
object Japanese
object Korean
object Latvian
object Lithuanian
object Norwegian
object Polish
object Portuguese
object Romanian
object Russian
object Serbian
object Slovak
object Slovenian
object Spanish
object Swedish
object Thai
object Turkish
object Ukrainian
object Vietnamese
Show all
final case class ContentLength(length: Long) extends Header

The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.

The Content-Length header indicates the size of the message body, in bytes, sent to the recipient.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ContentLength extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class ContentLocation(value: URI) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ContentLocation extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class ContentMd5(value: String) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ContentMd5 extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
ContentMd5.type
object ContentRange extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ContentRange extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class EndTotal
class RangeTotal
class StartEnd
object ContentSecurityPolicy extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ContentSecurityPolicy extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class PluginTypes
class Referrer
class ReportTo
class ReportUri
class Sandbox
class SourcePolicy
class TrustedTypes
Show all
object ContentTransferEncoding extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait ContentTransferEncoding extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Base64
object Binary
object EightBit
object SevenBit
class XToken
Show all
final case class ContentType(mediaType: MediaType, boundary: Option[Boundary] = ..., charset: Option[Charset] = ...) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ContentType extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class Cookie(value: NonEmptyChunk[Request]) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Cookie extends HeaderType

The Cookie HTTP request header contains stored HTTP cookies associated with the server.

The Cookie HTTP request header contains stored HTTP cookies associated with the server.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Cookie.type
final case class Custom(customName: CharSequence, value: CharSequence) extends Header

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object DNT extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
DNT.type
sealed trait DNT extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object NotSpecified
final case class Date(value: ZonedDateTime) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Date extends HeaderType

The Date general HTTP header contains the date and time at which the message originated.

The Date general HTTP header contains the date and time at which the message originated.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Date.type
object ETag extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
ETag.type
sealed trait ETag extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Strong
class Weak
object Expect extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Expect.type
sealed trait Expect extends Header

The Expect HTTP request header indicates expectations that need to be met by the server to handle the request successfully. There is only one defined expectation: 100-continue

The Expect HTTP request header indicates expectations that need to be met by the server to handle the request successfully. There is only one defined expectation: 100-continue

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object 100-continue
final case class Expires(value: ZonedDateTime) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Expires extends HeaderType

The Expires HTTP header contains the date/time after which the response is considered expired.

The Expires HTTP header contains the date/time after which the response is considered expired.

Invalid expiration dates with value 0 represent a date in the past and mean that the resource is already expired.

Expires:

Date: , : : GMT

Example:

Expires: Wed, 21 Oct 2015 07:28:00 GMT

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Expires.type
final case class Forwarded(by: Option[String] = ..., forValues: List[String] = ..., host: Option[String] = ..., proto: Option[String] = ...) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Forwarded extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Forwarded.type
final case class From(email: String) extends Header

From header value.

From header value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object From extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
From.type
object HeaderType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
HeaderType.type
sealed trait HeaderType extends HeaderTypeBase

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Accept
object AcceptPatch
object AcceptRanges
object Age
object Allow
object Basic
object Bearer
object Digest
object Authorization
object CacheControl
object ClearSiteData
object Connection
object ContentBase
object ContentLength
object ContentMd5
object ContentRange
object ContentType
object Cookie
object DNT
object Date
object ETag
object Expect
object Expires
object Forwarded
object From
object Host
object IfMatch
object IfNoneMatch
object IfRange
object LastModified
object Link
object Location
object MaxForwards
object Origin
object Pragma
object Range
object Referer
object RetryAfter
object Server
object SetCookie
object Te
object Trailer
object Upgrade
object UserAgent
object Vary
object Via
object XFrameOptions
Show all
object HeaderTypeBase

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait HeaderType
object Accept
object AcceptPatch
object AcceptRanges
object Age
object Allow
object Basic
object Bearer
object Digest
object Authorization
object CacheControl
object ClearSiteData
object Connection
object ContentBase
object ContentLength
object ContentMd5
object ContentRange
object ContentType
object Cookie
object DNT
object Date
object ETag
object Expect
object Expires
object Forwarded
object From
object Host
object IfMatch
object IfNoneMatch
object IfRange
object LastModified
object Link
object Location
object MaxForwards
object Origin
object Pragma
object Range
object Referer
object RetryAfter
object Server
object SetCookie
object Te
object Trailer
object Upgrade
object UserAgent
object Vary
object Via
object XFrameOptions
Show all
final case class Host(hostAddress: String, port: Option[Int] = ...) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Host extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Host.type
object IfMatch extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
IfMatch.type
sealed trait IfMatch extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Any
class ETags
final case class IfModifiedSince(value: ZonedDateTime) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object IfModifiedSince extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object IfNoneMatch extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait IfNoneMatch extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Any
class ETags
object IfRange extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
IfRange.type
sealed trait IfRange extends Header

The If-Range HTTP request header makes a range request conditional. Possible values:

The If-Range HTTP request header makes a range request conditional. Possible values:

  • , : : GMT
  • a string of ASCII characters placed between double quotes (Like "675af34563dc-tr34"). A weak entity tag (one prefixed by W/) must not be used in this header.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class DateTime
class ETag
final case class IfUnmodifiedSince(value: ZonedDateTime) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object IfUnmodifiedSince extends HeaderType

If-Unmodified-Since request header makes the request for the resource conditional: the server will send the requested resource or accept it in the case of a POST or another non-safe method only if the resource has not been modified after the date specified by this HTTP header.

If-Unmodified-Since request header makes the request for the resource conditional: the server will send the requested resource or accept it in the case of a POST or another non-safe method only if the resource has not been modified after the date specified by this HTTP header.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class LastModified(value: ZonedDateTime) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object LastModified extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class Link(uri: URL, params: Map[String, String]) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Link extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Link.type
final case class Location(url: URL) extends Header

Location header value.

Location header value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Location extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Location.type
final case class MaxForwards(value: Int) extends Header

Max-Forwards header value

Max-Forwards header value

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object MaxForwards extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object Origin extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Origin.type
sealed trait Origin extends Header

Origin header value.

Origin header value.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Null
class Value
object Pragma extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Pragma.type
sealed trait Pragma extends Header

Pragma header value.

Pragma header value.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object NoCache
final case class ProxyAuthenticate(scheme: AuthenticationScheme, realm: Option[String]) extends Header

The HTTP Proxy-Authenticate response header defines the authentication method that should be used to gain access to a resource behind a proxy server. It authenticates the request to the proxy server, allowing it to transmit the request further.

The HTTP Proxy-Authenticate response header defines the authentication method that should be used to gain access to a resource behind a proxy server. It authenticates the request to the proxy server, allowing it to transmit the request further.

Value parameters

realm

A description of the protected area, the realm. If no realm is specified, clients often display a formatted host name instead.

scheme

Authentication type

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ProxyAuthenticate extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class ProxyAuthorization(authenticationScheme: AuthenticationScheme, credential: String) extends Header

Proxy-Authorization:

Proxy-Authorization:

- AuthenticationScheme

- The resulting string is base64 encoded

Example

Proxy-Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object ProxyAuthorization extends HeaderType

The HTTP Proxy-Authorization request header contains the credentials to authenticate a user agent to a proxy server, usually after the server has responded with a 407 Proxy Authentication Required status and the Proxy-Authenticate header.

The HTTP Proxy-Authorization request header contains the credentials to authenticate a user agent to a proxy server, usually after the server has responded with a 407 Proxy Authentication Required status and the Proxy-Authenticate header.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object Range extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Range.type
sealed trait Range extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Multiple
class Prefix
class Single
class Suffix
final case class Referer(url: URL) extends Header

The Referer HTTP request header contains the absolute or partial address from which a resource has been requested. The Referer header allows a server to identify referring pages that people are visiting from or where requested resources are being used. This data can be used for analytics, logging, optimized caching, and more.

The Referer HTTP request header contains the absolute or partial address from which a resource has been requested. The Referer header allows a server to identify referring pages that people are visiting from or where requested resources are being used. This data can be used for analytics, logging, optimized caching, and more.

When you click a link, the Referer contains the address of the page that includes the link. When you make resource requests to another domain, the Referer contains the address of the page that uses the requested resource.

The Referer header can contain an origin, path, and querystring, and may not contain URL fragments (i.e. #section) or username:password information. The request's referrer policy defines the data that can be included. See Referrer-Policy for more information and examples.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Referer extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Referer.type
object RetryAfter extends HeaderType

The RetryAfter HTTP header contains the date/time after which to retry

The RetryAfter HTTP header contains the date/time after which to retry

RetryAfter:

Date: , : : GMT

Example:

Expires: Wed, 21 Oct 2015 07:28:00 GMT

Or RetryAfter the delay seconds.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
RetryAfter.type
sealed trait RetryAfter extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class ByDate
class ByDuration
object SchemaHeaderType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait SchemaHeaderType extends HeaderTypeBase

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
final case class SecWebSocketAccept(hashedKey: String) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SecWebSocketAccept extends HeaderType

The Sec-WebSocket-Accept header is used in the websocket opening handshake. It would appear in the response headers. That is, this is header is sent from server to client to inform that server is willing to initiate a websocket connection.

The Sec-WebSocket-Accept header is used in the websocket opening handshake. It would appear in the response headers. That is, this is header is sent from server to client to inform that server is willing to initiate a websocket connection.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Accept

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
object SecWebSocketExtensions extends HeaderType

The Sec-WebSocket-Extensions header is used in the WebSocket handshake. It is initially sent from the client to the server, and then subsequently sent from the server to the client, to agree on a set of protocol-level extensions to use during the connection.

The Sec-WebSocket-Extensions header is used in the WebSocket handshake. It is initially sent from the client to the server, and then subsequently sent from the server to the client, to agree on a set of protocol-level extensions to use during the connection.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Extensions

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait SecWebSocketExtensions extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Extensions
class Token
final case class SecWebSocketKey(base64EncodedKey: String) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SecWebSocketKey extends HeaderType

The Sec-WebSocket-Key header is used in the WebSocket handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g. HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.

The Sec-WebSocket-Key header is used in the WebSocket handshake. It is sent from the client to the server to provide part of the information used by the server to prove that it received a valid WebSocket handshake. This helps ensure that the server does not accept connections from non-WebSocket clients (e.g. HTTP clients) that are being abused to send data to unsuspecting WebSocket servers.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Key

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class SecWebSocketLocation(url: URL) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SecWebSocketLocation extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class SecWebSocketOrigin(url: URL) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SecWebSocketOrigin extends HeaderType

The Sec-WebSocket-Origin header is used to protect against unauthorized cross-origin use of a WebSocket server by scripts using the |WebSocket| API in a Web browser. The server is informed of the script origin generating the WebSocket connection request.

The Sec-WebSocket-Origin header is used to protect against unauthorized cross-origin use of a WebSocket server by scripts using the |WebSocket| API in a Web browser. The server is informed of the script origin generating the WebSocket connection request.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class SecWebSocketProtocol(subProtocols: NonEmptyChunk[String]) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SecWebSocketProtocol extends HeaderType

The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake. It is sent from the client to the server and back from the server to the client to confirm the subprotocol of the connection. This enables scripts to both select a subprotocol and be sure that the server agreed to serve that subprotocol.

The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake. It is sent from the client to the server and back from the server to the client to confirm the subprotocol of the connection. This enables scripts to both select a subprotocol and be sure that the server agreed to serve that subprotocol.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Protocol

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class SecWebSocketVersion(version: Int) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SecWebSocketVersion extends HeaderType

The Sec-WebSocket-Version header field is used in the WebSocket opening handshake. It is sent from the client to the server to indicate the protocol version of the connection.

The Sec-WebSocket-Version header field is used in the WebSocket opening handshake. It is sent from the client to the server to indicate the protocol version of the connection.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Version

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class Server(name: String) extends Header

Server header value.

Server header value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Server extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Server.type
final case class SetCookie(value: Response) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object SetCookie extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
SetCookie.type
object Te extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Te.type
sealed trait Te extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Compress
class Deflate
class GZip
class Multiple
object Trailers
final case class Trailer(header: String) extends Header

Trailer header value.

Trailer header value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object Trailer extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Trailer.type
object TransferEncoding extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait TransferEncoding extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Chunked
object Compress
object Deflate
object GZip
class Multiple
object Upgrade extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Upgrade.type
sealed trait Upgrade extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Multiple
class Protocol
final case class UpgradeInsecureRequests() extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object UpgradeInsecureRequests extends HeaderType

The HTTP Upgrade-Insecure-Requests request header sends a signal to the server expressing the client's preference for an encrypted and authenticated response.

The HTTP Upgrade-Insecure-Requests request header sends a signal to the server expressing the client's preference for an encrypted and authenticated response.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
final case class UserAgent(product: Product, parts: List[ProductOrComment] = ...) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object UserAgent extends HeaderType

The "User-Agent" header field contains information about the user agent originating the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use

The "User-Agent" header field contains information about the user agent originating the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
UserAgent.type
object Vary extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Vary.type
sealed trait Vary extends Header

Vary header value.

Vary header value.

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Headers
object Star
object Via extends HeaderType

The Via general header is added by proxies, both forward and reverse, and can appear in the request or response headers. It is used for tracking message forwards, avoiding request loops, and identifying the protocol capabilities of senders along the request/response chain

The Via general header is added by proxies, both forward and reverse, and can appear in the request or response headers. It is used for tracking message forwards, avoiding request loops, and identifying the protocol capabilities of senders along the request/response chain

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
Via.type
sealed trait Via extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Detailed
class Multiple
object WWWAuthenticate extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait WWWAuthenticate extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
class Basic
class Bearer
class Digest
class HOBA
class Mutual
class Negotiate
class SCRAM
class Unknown
Show all
object XFrameOptions extends HeaderType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type
sealed trait XFrameOptions extends Header

Attributes

Companion
object
Supertypes
trait Header
class Object
trait Matchable
class Any
Known subtypes
object Deny
object SameOrigin
final case class XRequestedWith(value: String) extends Header

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Header
class Object
trait Matchable
class Any
Show all
object XRequestedWith extends HeaderType

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait HeaderType
class Object
trait Matchable
class Any
Show all
Self type

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
Generated with