OptionalHeaderField

class OptionalHeaderField<T>(val inner: HeaderField<T>) : HeaderField<T?>

A header field that is optional.

Constructors

Link copied to clipboard
constructor(inner: HeaderField<T>)

Properties

Link copied to clipboard
open override val field: String
Link copied to clipboard
open override val fields: List<String>

The fields for this header field.

Link copied to clipboard

Functions

Link copied to clipboard
infix fun <A, B> HeaderField<A>.and(other: HeaderField<B>): HeaderPairField<A, B>

Creates a pair of header fields as HeaderPairField.

Link copied to clipboard
infix fun <T> HeaderField<T>.bind(value: T): T

Binds a value to a HeaderField for readable typed header construction. This is a pass-through that ensures the value matches the field type.

Link copied to clipboard
open fun createHeaders(value: T?): Headers

Creates a Headers object from the given value.

Link copied to clipboard
context(_: Raise<Issue>)
open override fun decode(headers: Headers): T?
Link copied to clipboard
open override fun encodeHeaders(value: T?): Map<String, List<String>>
Link copied to clipboard
open override fun flatten(): List<HeaderField<*>>

Flattens the HeaderField into its constituent fields.

Link copied to clipboard

Marks a header field as optional.