Packages

final class Headers extends AnyVal

A collection of HTTP Headers

Source
Headers.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Headers
  2. AnyVal
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def ++(that: Headers): Headers

    Concatenate the two collections If the resulting collection is of Headers type, duplicate Singleton headers will be removed from this Headers collection.

    Concatenate the two collections If the resulting collection is of Headers type, duplicate Singleton headers will be removed from this Headers collection.

    that

    collection to append

  2. def collectFirst[B](f: PartialFunction[Header, B]): Option[B]
  3. def count(f: (Header) ⇒ Boolean): Int
  4. def drop(n: Int): Headers
  5. def exists(f: (Header) ⇒ Boolean): Boolean
  6. def filter(f: (Header) ⇒ Boolean): Headers
  7. def filterNot(f: (Header) ⇒ Boolean): Headers
  8. def find(f: (Header) ⇒ Boolean): Option[Header]
  9. def foldLeft[A](z: A)(f: (A, Header) ⇒ A): A
  10. def foldMap[B](f: (Header) ⇒ B)(implicit arg0: Monoid[B]): B
  11. def foldRight[A](z: Eval[A])(f: (Header, Eval[A]) ⇒ Eval[A]): Eval[A]
  12. def forall(f: (Header) ⇒ Boolean): Boolean
  13. def foreach(f: (Header) ⇒ Unit): Unit
  14. def get(key: CaseInsensitiveString): Option[Header]

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

    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

  15. def get(key: Extractable): Option[HeaderKey.Extractable.HeaderT]

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

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

    key

    HeaderKey.Extractable that can identify the required header

    returns

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

    See also

    Header object and get(org.http4s.util.CaseInsensitiveString)

  16. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  17. def isEmpty: Boolean
  18. def iterator: Iterator[Header]
  19. def nonEmpty: Boolean
  20. def put(in: Header*): Headers

    Make a new collection adding the specified headers, replacing existing headers of singleton type The passed headers are assumed to contain no duplicate Singleton headers.

    Make a new collection adding the specified headers, replacing existing headers of singleton type The passed headers are assumed to contain no duplicate Singleton headers.

    in

    multiple Header to append to the new collection

    returns

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

  21. def redactSensitive(redactWhen: (CaseInsensitiveString) ⇒ Boolean = Headers.SensitiveHeaders.contains): Headers
  22. 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

  23. def size: Int
  24. def toList: List[Header]
  25. def toString(): String
    Definition Classes
    Headers → Any

Deprecated Value Members

  1. def get(key: Set-Cookie.type): Option[Set-Cookie]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.0-RC1) Use response.cookies instead. Set-Cookie is unique among HTTP headers in that it can be repeated but can't be joined by a ','. This will return only the first Set-Cookie header. response.cookies will return the complete list.