Packages

p

org.http4s

headers

package headers

Source
package.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. headers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Accept(values: NonEmptyList[MediaRangeAndQValue]) extends RecurringRenderable with Product with Serializable
  2. final case class Accept-Charset(values: NonEmptyList[CharsetRange]) extends RecurringRenderable with Product with Serializable

    The "Accept-Charset" header field can be sent by a user agent to
    indicate what charsets are acceptable in textual response content.
    This field allows user agents capable of understanding more

    From [http//tools.ietf.org/html/rfc7231#section-5.3.3 RFC-7231].

  3. final case class Accept-Encoding(values: NonEmptyList[ContentCoding]) extends RecurringRenderable with Product with Serializable
  4. final case class Accept-Language(values: NonEmptyList[LanguageTag]) extends RecurringRenderable with Product with Serializable

    Request header used to indicate which natural language would be preferred for the response to be translated into.

    Request header used to indicate which natural language would be preferred for the response to be translated into.

    RFC-7231 Section 5.3.5

  5. final case class Accept-Patch extends RecurringRenderer with Product with Serializable
  6. final case class Accept-Ranges extends Parsed with Product with Serializable
  7. final case class Access-Control-Allow-Credentials() extends Parsed with Product with Serializable
  8. final case class Access-Control-Allow-Headers(values: NonEmptyList[CIString]) extends RecurringRenderer with Product with Serializable
  9. final case class Access-Control-Expose-Headers(values: NonEmptyList[CIString]) extends RecurringRenderer with Product with Serializable
  10. sealed abstract case class Age extends Parsed with Product with Serializable

    Constructs an Age header.

    Constructs an Age header.

    The value of this field is a positive number of seconds (in decimal) with an estimate of the amount of time since the response

  11. final case class Allow(methods: Set[Method]) extends Parsed with Product with Serializable

    A Response header that lists the methods that are supported by the target resource.

    A Response header that lists the methods that are supported by the target resource. Often attached to responses with status 405 Not Allowed.

    RFC-7231 Section 7.4.1 Allow

  12. final case class Authorization(credentials: Credentials) extends Parsed with Product with Serializable
  13. final case class Cache-Control(values: NonEmptyList[CacheDirective]) extends RecurringRenderable with Product with Serializable
  14. final case class Connection(values: NonEmptyList[CIString]) extends Recurring with Product with Serializable
  15. final case class Content-Disposition(dispositionType: String, parameters: Map[String, String]) extends Parsed with Product with Serializable
  16. final case class Content-Encoding(contentCoding: ContentCoding) extends Parsed with Product with Serializable
  17. final case class Content-Language(values: NonEmptyList[LanguageTag]) extends RecurringRenderable with Product with Serializable
  18. sealed abstract case class Content-Length extends Parsed with Product with Serializable

    Constructs a Content-Length header.

    Constructs a Content-Length header.

    The HTTP RFCs do not specify a maximum length. We have decided that Long.MaxValue bytes ought to be good enough for anybody in order to avoid the irritations of BigInt.

  19. final case class Content-Location(uri: Uri) extends Parsed with Product with Serializable

    The "Content-Location" header field references a URI that can be used
    as an identifier for a specific resource corresponding to the
    representation in this message's payload

    RFC-7231 Section 3.1.4.2

  20. final case class Content-Range(unit: RangeUnit, range: SubRange, length: Option[Long]) extends Parsed with Product with Serializable
  21. final case class Content-Type extends Parsed with Product with Serializable

    The "Content-Type" header field indicates the media type of the
    associated representation: either the representation enclosed in the
    message payload or the selected representation, as determined by the
    message semantics.

    RFC-7231

  22. final case class Cookie(values: NonEmptyList[RequestCookie]) extends RecurringRenderable with Product with Serializable
  23. final case class Date(date: HttpDate) extends Parsed with Product with Serializable
  24. final case class ETag(tag: EntityTag) extends Parsed with Product with Serializable
  25. final case class Expires(expirationDate: HttpDate) extends Parsed with Product with Serializable

    A Response header that _gives the date/time after which the response is considered stale_.

    A Response header that _gives the date/time after which the response is considered stale_.

    The HTTP RFCs indicate that Expires should be in the range of now to 1 year in the future. However, it is a usual practice to set it to the past of far in the future Thus any instant is in practice allowed

    RFC-7234 Section 5.3

    expirationDate

    the date of expiration. The RFC has a warning, that using large values can cause problems due to integer or clock overflows.

  26. final case class Forwarded(values: NonEmptyList[Element]) extends RecurringRenderable with Product with Serializable
  27. final case class Host(host: String, port: Option[Int] = None) extends Parsed with Product with Serializable

    A Request header, that provides the host and port informatio

    A Request header, that provides the host and port informatio

    The "Host" header field in a request provides the host and port
    information from the target URI, enabling the origin server to
    distinguish among resources while servicing requests for multiple
    host names on a single IP address.

    This header was mandatory in version 1.1 of the Http protocol.

    RFC-7230 Section 5.4

  28. final case class If-Match(tags: Option[NonEmptyList[EntityTag]]) extends Parsed with Product with Serializable

    Request header to make the request conditional on the current contents of the origin server at the given target resource (URI).

    Request header to make the request conditional on the current contents of the origin server at the given target resource (URI).

    RFC-7232 Section 3.1

  29. final case class If-Modified-Since(date: HttpDate) extends Parsed with Product with Serializable

    {{ The "If-Modified-Since" header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value.

    {{ The "If-Modified-Since" header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. }}

    RFC-7232

  30. final case class If-None-Match(tags: Option[NonEmptyList[EntityTag]]) extends Parsed with Product with Serializable
  31. final case class If-Unmodified-Since(date: HttpDate) extends Parsed with Product with Serializable
  32. final case class Last-Event-Id(id: EventId) extends Parsed with Product with Serializable
  33. final case class Last-Modified(date: HttpDate) extends Parsed with Product with Serializable

    Response header that indicates the time at which the server believes the entity was last modified.

    Response header that indicates the time at which the server believes the entity was last modified.

    RFC-7232

  34. final case class Link(values: NonEmptyList[LinkValue]) extends RecurringRenderable with Product with Serializable
  35. final case class LinkValue(uri: Uri, rel: Option[String] = None, rev: Option[String] = None, title: Option[String] = None, type: Option[MediaRange] = None) extends Renderable with Product with Serializable
  36. final case class Location(uri: Uri) extends Parsed with Product with Serializable
  37. sealed abstract case class Max-Forwards extends Parsed with Product with Serializable

    Request header, used with the TRACE and OPTION request methods, that gives an upper bound on how many times the request can be forwarded by a proxy before it is rejected.

    Request header, used with the TRACE and OPTION request methods, that gives an upper bound on how many times the request can be forwarded by a proxy before it is rejected.

    RFC-7231

  38. final case class MediaRangeAndQValue(mediaRange: MediaRange, qValue: QValue = QValue.One) extends Renderable with Product with Serializable
  39. sealed abstract class Origin extends Parsed
  40. final case class Proxy-Authenticate(values: NonEmptyList[Challenge]) extends RecurringRenderable with Product with Serializable

    The "Proxy-Authenticate" header field consists of at least one
    challenge that indicates the authentication scheme(s) and parameters
    applicable to the proxy for this effective request URI...

    From RFC-7235

  41. final case class Range(unit: RangeUnit, ranges: NonEmptyList[SubRange]) extends Parsed with Product with Serializable
  42. final case class Referer(uri: Uri) extends Parsed with Product with Serializable
  43. sealed abstract case class Retry-After extends Parsed with Product with Serializable

    Response header, used by the server to indicate to the user-agent how long it has to wait before it can try again with a follow-up request.

    Response header, used by the server to indicate to the user-agent how long it has to wait before it can try again with a follow-up request.

    RFC-7231 Section 7.1.3

  44. final case class Server(product: ProductId, rest: List[ProductIdOrComment]) extends Parsed with Product with Serializable

    Server header https://tools.ietf.org/html/rfc7231#section-7.4.2

  45. final case class Set-Cookie(cookie: ResponseCookie) extends Parsed with Product with Serializable
  46. sealed abstract case class Strict-Transport-Security extends Parsed with Product with Serializable
  47. final case class Transfer-Encoding(values: NonEmptyList[TransferCoding]) extends RecurringRenderable with Product with Serializable
  48. final case class User-Agent(product: ProductId, rest: List[ProductIdOrComment]) extends Parsed with Product with Serializable

    User-Agent header RFC-7231 Section 5.5.3

  49. final case class WWW-Authenticate(values: NonEmptyList[Challenge]) extends RecurringRenderable with Product with Serializable
  50. final case class X-B3-Flags(flags: Set[Flag]) extends Parsed with Product with Serializable
  51. final case class X-B3-ParentSpanId(id: Long) extends Parsed with Product with Serializable
  52. final case class X-B3-Sampled(sampled: Boolean) extends Parsed with Product with Serializable
  53. final case class X-B3-SpanId(id: Long) extends Parsed with Product with Serializable
  54. final case class X-B3-TraceId(idMostSigBits: Long, idLeastSigBits: Option[Long]) extends Parsed with Product with Serializable
  55. final case class X-Forwarded-For(values: NonEmptyList[Option[InetAddress]]) extends Recurring with Product with Serializable
  56. type AgentComment = ProductComment
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0-M1) Deprecated in favor of ProductComment

  57. type AgentProduct = ProductId
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0-M1) Deprecated in favor of ProductId

  58. type AgentToken = ProductIdOrComment
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0-M1) Deprecated in favor of ProductIdOrComment

Value Members

  1. object Accept extends Internal[Accept] with Recurring with Serializable
  2. object Accept-Charset extends Internal[Accept-Charset] with Recurring with Serializable
  3. object Accept-Encoding extends Internal[Accept-Encoding] with Recurring with Serializable
  4. object Accept-Language extends Internal[Accept-Language] with Recurring with Serializable
  5. object Accept-Patch extends Internal[Accept-Patch] with Recurring with Serializable
  6. object Accept-Ranges extends Internal[Accept-Ranges] with Singleton with Serializable
  7. object Access-Control-Allow-Credentials extends Internal[Access-Control-Allow-Credentials] with Serializable
  8. object Access-Control-Allow-Headers extends Internal[Access-Control-Allow-Headers] with Recurring with Serializable
  9. object Access-Control-Allow-Methods extends Internal[Header] with Default
  10. object Access-Control-Allow-Origin extends Internal[Header] with Default
  11. object Access-Control-Expose-Headers extends Internal[Access-Control-Expose-Headers] with Recurring with Serializable
  12. object Access-Control-Max-Age extends Internal[Header] with Default
  13. object Access-Control-Request-Headers extends Internal[Header] with Default
  14. object Access-Control-Request-Method extends Internal[Header] with Default
  15. object Age extends Internal[Age] with Singleton with Serializable
  16. object Allow extends Internal[Allow] with Singleton with Serializable
  17. object Authorization extends Internal[Authorization] with Singleton with Serializable
  18. object Cache-Control extends Internal[Cache-Control] with Recurring with Serializable
  19. object Connection extends Internal[Connection] with Recurring with Serializable
  20. object Content-Base extends Internal[Header] with Default
  21. object Content-Disposition extends Internal[Content-Disposition] with Singleton with Serializable
  22. object Content-Encoding extends Internal[Content-Encoding] with Singleton with Serializable
  23. object Content-Language extends Internal[Content-Language] with Recurring with Serializable
  24. object Content-Length extends Internal[Content-Length] with Singleton with Serializable
  25. object Content-Location extends Internal[Content-Location] with Singleton with Serializable
  26. object Content-MD5 extends Internal[Header] with Default
  27. object Content-Range extends Internal[Content-Range] with Singleton with Serializable
  28. object Content-Security-Policy extends Internal[Header] with Default

    Defined by http://www.w3.org/TR/CSP/

  29. object Content-Transfer-Encoding extends Internal[Header] with Default
  30. object Content-Type extends Internal[Content-Type] with Singleton with Serializable
  31. object Cookie extends Internal[Cookie] with Recurring with Serializable
  32. object Date extends Internal[Date] with Singleton with Serializable
  33. object ETag extends Internal[ETag] with Singleton with Serializable
  34. object Expect extends Internal[Header] with Default

    RFC-7231 Section 5.1.1

  35. object Expires extends Internal[Expires] with Singleton with Serializable
  36. object Forwarded extends Internal[Forwarded] with Recurring with ForwardedRenderers with ForwardedModelParsing with Serializable
  37. object From extends Internal[Header] with Default
  38. object Front-End-Https extends Internal[Header] with Default
  39. object Host extends Internal[Host] with Singleton with Serializable
  40. object If-Match extends Internal[If-Match] with Singleton with Serializable
  41. object If-Modified-Since extends Internal[If-Modified-Since] with Singleton with Serializable
  42. object If-None-Match extends Internal[If-None-Match] with Singleton with Serializable

    The "If-None-Match" header field makes the request method conditional
    on a recipient cache or origin server either not having any current
    representation of the target resource, when the field-value is "*",
    or having a selected representation with an entity-tag that does not
    match any of those listed in the field-value.

    From RFC-7232

  43. object If-Range extends Internal[Header] with Default

    RFC-7233 Section 3.2

  44. object If-Unmodified-Since extends Internal[If-Unmodified-Since] with Singleton with Serializable
  45. object Last-Event-Id extends Internal[Last-Event-Id] with Singleton with Serializable
  46. object Last-Modified extends Internal[Last-Modified] with Singleton with Serializable
  47. object Link extends Internal[Link] with Recurring with Serializable
  48. object Location extends Internal[Location] with Singleton with Serializable
  49. object Max-Forwards extends Internal[Max-Forwards] with Singleton with Serializable
  50. object MediaRangeAndQValue extends Serializable
  51. object Origin extends Internal[Origin] with Singleton
  52. object Pragma extends Internal[Header] with Default
  53. object Proxy-Authenticate extends Internal[Proxy-Authenticate] with Recurring with Serializable
  54. object Proxy-Authentication extends Internal[Header] with Default
  55. object Proxy-Authorization extends Internal[Header] with Default

    The "Proxy-Authorization" header field allows the client to identify
    itself (or its user) to a proxy that requires authentication.

    From RFC-7235

  56. object Range extends Internal[Range] with Singleton with Serializable
  57. object Referer extends Internal[Referer] with Singleton with Serializable
  58. object Retry-After extends Internal[Retry-After] with Singleton with Serializable
  59. object Sec-WebSocket-Accept extends Internal[Header] with Default
  60. object Sec-WebSocket-Key extends Internal[Header] with Default
  61. object Sec-WebSocket-Key1 extends Internal[Header] with Default
  62. object Sec-WebSocket-Key2 extends Internal[Header] with Default
  63. object Sec-WebSocket-Location extends Internal[Header] with Default
  64. object Sec-WebSocket-Origin extends Internal[Header] with Default
  65. object Sec-WebSocket-Protocol extends Internal[Header] with Default
  66. object Sec-WebSocket-Version extends Internal[Header] with Default
  67. object Server extends Internal[Server] with Singleton with Serializable
  68. object Set-Cookie extends Internal[Set-Cookie] with Serializable
  69. object Strict-Transport-Security extends Internal[Strict-Transport-Security] with Singleton with Serializable

    Defined by http://tools.ietf.org/html/rfc6797

  70. object TE extends Internal[Header] with Default
  71. object Trailer extends Internal[Header] with Default
  72. object Transfer-Encoding extends Internal[Transfer-Encoding] with Recurring with Serializable
  73. object Upgrade extends Internal[Header] with Default
  74. object User-Agent extends Internal[User-Agent] with Singleton with Serializable
  75. object Vary extends Internal[Header] with Default
  76. object Via extends Internal[Header] with Default
  77. object WWW-Authenticate extends Internal[WWW-Authenticate] with Recurring with Serializable
  78. object Warning extends Internal[Header] with Default
  79. object WebSocket-Location extends Internal[Header] with Default
  80. object WebSocket-Origin extends Internal[Header] with Default
  81. object WebSocket-Protocol extends Internal[Header] with Default
  82. object X-B3-Flags extends Internal[X-B3-Flags] with Singleton with Serializable
  83. object X-B3-ParentSpanId extends Internal[X-B3-ParentSpanId] with Singleton with Serializable
  84. object X-B3-Sampled extends Internal[X-B3-Sampled] with Singleton with Serializable
  85. object X-B3-SpanId extends Internal[X-B3-SpanId] with Singleton with Serializable
  86. object X-B3-TraceId extends Internal[X-B3-TraceId] with Singleton with Serializable
  87. object X-Content-Type-Options extends Internal[Header] with Default
  88. object X-Forwarded-For extends Internal[X-Forwarded-For] with Recurring with Serializable
  89. object X-Forwarded-Proto extends Internal[Header] with Default
  90. object X-Frame-Options extends Internal[Header] with Default

    Defined by http://tools.ietf.org/html/rfc7034#section-2.1

  91. object X-Powered-By extends Internal[Header] with Default

    Non-Standard Http Header, which is often added to a Response to indicate that the response was built with a certain scripting technology, such as "ASP".

    Non-Standard Http Header, which is often added to a Response to indicate that the response was built with a certain scripting technology, such as "ASP".

    https://stackoverflow.com/a/33580769/1002111

  92. object X-Requested-With extends Internal[Header] with Default

Inherited from AnyRef

Inherited from Any

Ungrouped