Packages

final class Headers extends AnyVal

A collection of HTTP Headers

Source
Headers.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Headers
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Headers(headers: List[Raw])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def ++(those: Headers): Headers
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  5. def add[H](h: H)(implicit arg0: Header[H, Recurring]): Headers
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def foreach(f: (Raw) ⇒ Unit): Unit
  8. def get(key: CIString): Option[NonEmptyList[Raw]]

    TODO revise scaladoc Attempt to get a org.http4s.Header from this collection of headers

    TODO revise scaladoc Attempt to get a org.http4s.Header from this collection of headers

    key

    name of the header to find

    returns

    a scala.Option possibly containing the resulting org.http4s.Header

  9. def get[A](implicit ev: Select[A]): Option[F[A]]

    TODO revise scaladoc Attempt to get a org.http4s.Header of type key.HeaderT from this collection

    TODO revise scaladoc Attempt to get a org.http4s.Header of type key.HeaderT from this collection

    returns

    a scala.Option possibly containing the resulting header of type key.HeaderT

    See also

    Header object and get(org.typelevel.ci.CIString)

  10. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  11. def getWithWarnings[A](implicit ev: Select[A]): Option[Ior[NonEmptyList[ParseFailure], F[A]]]

    TODO revise scaladoc Attempt to get a org.http4s.Header of type key.HeaderT from this collection

    TODO revise scaladoc Attempt to get a org.http4s.Header of type key.HeaderT from this collection

    returns

    a scala.Option possibly containing the resulting header of type key.HeaderT and/or any parse errors.

    See also

    Header object and get(org.typelevel.ci.CIString)

  12. val headers: List[Raw]
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def put(in: ToRaw*): Headers

    Make a new collection adding the specified headers, replacing existing Single headers.

    Make a new collection adding the specified headers, replacing existing Single headers.

    in

    multiple heteregenous headers Header to append to the new collection, see Header.ToRaw

    returns

    a new Headers containing the sum of the initial and input headers

  15. def redactSensitive(redactWhen: (CIString) ⇒ Boolean = Headers.SensitiveHeaders.contains): Headers
  16. def removePayloadHeaders: Headers

    Removes the Content-Length, Content-Range, Trailer, and Transfer-Encoding headers.

    Removes the Content-Length, Content-Range, Trailer, and Transfer-Encoding headers.

    https://tools.ietf.org/html/rfc7231#section-3.3

  17. def toString(): String
    Definition Classes
    Headers → Any
  18. def transform(f: (List[Raw]) ⇒ List[Raw]): Headers

Inherited from AnyVal

Inherited from Any

Ungrouped