Packages

t

zio.http.internal

HeaderGetters

trait HeaderGetters extends AnyRef

Maintains a list of operators that parse and extract data from the headers.

NOTE: Add methods here if it performs some kind of processing on the header and returns the result.

Self Type
HeaderGetters
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HeaderGetters
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def headers: Headers

    Returns the headers

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def header[T](implicit schema: Schema[T]): Either[HeaderError, T]

    Retrieves headers as a value of the specified type.

    Retrieves headers as a value of the specified type. The type must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

  11. final def header[T](name: String)(implicit schema: Schema[T]): Either[HeaderError, T]

    Retrieves the header with the specified name as a value of the specified type.

    Retrieves the header with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

  12. final def header(headerType: HeaderType): Option[HeaderValue]

    Gets a header or returns None if the header was not present or it could not be parsed

  13. final def headerOrElse[T](default: => T)(implicit schema: Schema[T]): T

    Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed.

    Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed. The type T must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

  14. final def headerOrElse[T](name: String, default: => T)(implicit schema: Schema[T]): T

    Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed.

    Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed. The type T must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

  15. final def headerOrFail(headerType: HeaderType): Option[Either[String, HeaderValue]]

    Gets a header.

    Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

  16. final def headerZIO[T](name: String)(implicit schema: Schema[T]): IO[HeaderError, T]
  17. final def headers(headerType: HeaderType): Chunk[HeaderValue]
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  22. final def rawHeader(headerType: HeaderType): Option[String]

    Gets the raw unparsed header value

  23. final def rawHeader(name: CharSequence): Option[String]

    Gets the raw unparsed header value

  24. def rawHeaders(name: CharSequence): Chunk[String]
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped