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
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. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Headers to any2stringadd[Headers] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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

  5. def ->[B](y: B): (Headers, B)
    Implicit
    This member is added by an implicit conversion from Headers to ArrowAssoc[Headers] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def collectFirst[B](f: PartialFunction[Header, B]): Option[B]
  9. def count(f: (Header) ⇒ Boolean): Int
  10. def drop(n: Int): Headers
  11. def ensuring(cond: (Headers) ⇒ Boolean, msg: ⇒ Any): Headers
    Implicit
    This member is added by an implicit conversion from Headers to Ensuring[Headers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Headers) ⇒ Boolean): Headers
    Implicit
    This member is added by an implicit conversion from Headers to Ensuring[Headers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Headers
    Implicit
    This member is added by an implicit conversion from Headers to Ensuring[Headers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Headers
    Implicit
    This member is added by an implicit conversion from Headers to Ensuring[Headers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def exists(f: (Header) ⇒ Boolean): Boolean
  16. def filter(f: (Header) ⇒ Boolean): Headers
  17. def filterNot(f: (Header) ⇒ Boolean): Headers
  18. def find(f: (Header) ⇒ Boolean): Option[Header]
  19. def foldLeft[A](z: A)(f: (A, Header) ⇒ A): A
  20. def foldMap[B](f: (Header) ⇒ B)(implicit arg0: Monoid[B]): B
  21. def foldRight[A](z: Eval[A])(f: (Header, Eval[A]) ⇒ Eval[A]): Eval[A]
  22. def forall(f: (Header) ⇒ Boolean): Boolean
  23. def foreach(f: (Header) ⇒ Unit): Unit
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Headers to StringFormat[Headers] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. 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

  26. 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)

  27. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  28. def isEmpty: Boolean
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def iterator: Iterator[Header]
  31. def nonEmpty: Boolean
  32. 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

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

  35. def size: Int
  36. def toList: List[Header]
  37. def toString(): String
    Definition Classes
    Headers → Any
  38. def [B](y: B): (Headers, B)
    Implicit
    This member is added by an implicit conversion from Headers to ArrowAssoc[Headers] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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.

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion any2stringadd from Headers to any2stringadd[Headers]

Inherited by implicit conversion StringFormat from Headers to StringFormat[Headers]

Inherited by implicit conversion Ensuring from Headers to Ensuring[Headers]

Inherited by implicit conversion ArrowAssoc from Headers to ArrowAssoc[Headers]

Ungrouped