core/dev.akif.tapik/Header

Header

sealed interface Header<H : Any>(source)

Describes one HTTP header slot in an endpoint contract.

A header can either require the caller to supply a value, via HeaderInput, or carry concrete values up front, via HeaderValues. That lets Tapik use the same abstraction for request headers, dynamic response headers, and fixed response headers.

Inheritors

HeaderInput

HeaderValues

Types

Companion

object Companion : Defaults<Header<Unit>, Header<Boolean>, Header<Byte>, Header<Short>, Header<Int>, Header<Long>, Header<Float>, Header<Double>, Header<BigInteger>, Header<BigDecimal>, Header<String>, Header<UUID>>

Factory helpers and predefined standard headers.

Properties

codec

abstract val codec: StringCodec<H>

Codec responsible for encoding and decoding header values.

name

abstract val name: String

Canonical HTTP header name.

required

abstract val required: Boolean

Whether the header must be provided by the caller instead of being pre-populated.

Functions

invoke

open operator fun ~~invoke~~(): Nothing

open operator fun invoke(vararg values: H): HeaderValues<H>

Binds one or more concrete values to this header definition.