Headers

zio.http.Headers
See theHeaders companion object
final class Headers

Immutable collection of HTTP headers, backed by parallel arrays.

Header names are stored pre-lowercased for case-insensitive matching. Multiple headers with the same name are allowed (multi-value). The parsed array is populated lazily on typed get calls. The cache is an optimization only: duplicate benign parses are possible if the same Headers is read concurrently.

Attributes

Companion
object
Source
Headers.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def ++(other: Headers): Headers

Attributes

Source
Headers.scala
def add(header: Header): Headers

Attributes

Source
Headers.scala
def add(name: String, value: String): Headers

Attributes

Source
Headers.scala
def contains(name: String): Boolean

Attributes

Source
Headers.scala
override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source
Headers.scala
def get[A](headerCodec: Codec[A]): Option[A]

Decodes the first header matching the supplied codec.

Decodes the first header matching the supplied codec.

Matching is case-insensitive by header name. Parsed values are cached per header entry and codec instance so different codecs with the same name do not reuse each other's cached values.

Attributes

Source
Headers.scala
def getAll[A](headerCodec: Codec[A]): Chunk[A]

Decodes all headers matching the supplied codec.

Decodes all headers matching the supplied codec.

Values are returned in header order. Entries that fail to parse for the requested codec are skipped, and cached values are reused only when they were produced by the same codec instance.

Attributes

Source
Headers.scala
def getLast[H <: Header](headerType: Typed[H]): Option[H]

Attributes

Source
Headers.scala
def has(name: String): Boolean

Attributes

Source
Headers.scala
override def hashCode: Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
Headers.scala
def isEmpty: Boolean

Attributes

Source
Headers.scala
def nonEmpty: Boolean

Attributes

Source
Headers.scala
def rawGet(name: String): Option[String]

Attributes

Source
Headers.scala
def rawGetAll(name: String): Chunk[String]

Attributes

Source
Headers.scala
def rawGetLast(name: String): Option[String]

Attributes

Source
Headers.scala
def remove(name: String): Headers

Attributes

Source
Headers.scala
def set(name: String, value: String): Headers

Attributes

Source
Headers.scala
def set(header: Header): Headers

Attributes

Source
Headers.scala
def toChunk: Chunk[(String, String)]

Attributes

Source
Headers.scala
def toList: List[(String, String)]

Attributes

Source
Headers.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
Headers.scala

Concrete fields

val size: Int

Attributes

Source
Headers.scala