library/xyz.malefic.koven.contract.field

Package-level declarations

Types

@Serializable

data class Cookie(val name: String, val value: String, val maxAge: Long? = null, val path: String? = null, val domain: String? = null, val secure: Boolean = false, val httpOnly: Boolean = false, val sameSite: SameSite = SameSite.Lax)

A representation of an HTTP cookie.

CookieField

interface CookieField<T> : KovenField<T>

Interface for cookie fields, allowing type-safe retrieval and definition.

CookiePairField

class CookiePairField<A, B>(val fieldA: CookieField<A>, val fieldB: CookieField) : KovenPairField<A, B> , CookieField<KovenPair<A, B>>

A cookie field that combines two other cookie fields.

data class Cookies(val list: List<Cookie> = emptyList()) : List<Cookie>

A wrapper for cookies.

Empty

object Empty : HeaderField<Empty> , PathField<Empty> , QueryField<Empty> , CookieField<Empty>

Represents empty fields for Headers, Query Params, Path Params, and Cookies.

HeaderField

interface HeaderField<T> : KovenField<T>

Interface for header fields.

HeaderPairField

class HeaderPairField<A, B>(val fieldA: HeaderField<A>, val fieldB: HeaderField) : KovenPairField<A, B> , HeaderField<KovenPair<A, B>>

A header field that combines two other header fields. Used to decode KovenPair.

Headers

class Headers : Map<String, List<String>>

A wrapper for HTTP headers that maintains insertion order and supports multiple values. Header fields are treated case-insensitively.

HeadersField

object HeadersField : HeaderField<Headers>

A header field that decodes all headers into a Headers object.

KovenField

interface KovenField<out T>

Base interface for all field decoders.

KovenPair

data class KovenPair<out A, out B>(val first: A, val second: B)

A generic pair for composing values.

KovenPairField

abstract class KovenPairField<out A, out B>(val fieldA: KovenField<A>, val fieldB: KovenField) : KovenField<KovenPair<A, B>>

Base class for composite fields, handling field aggregation and flattening.

OptionalCookieField

class OptionalCookieField<T>(val inner: CookieField<T>) : CookieField<T?>

A cookie field that is optional.

OptionalHeaderField

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

A header field that is optional.

OptionalPathField

class OptionalPathField<T>(val inner: PathField<T>) : PathField<T?>

A path field that is optional.

OptionalQueryField

class OptionalQueryField<T>(val inner: QueryField<T>) : QueryField<T?>

A query field that is optional.

PathField

interface PathField<T> : KovenField<T>

Interface for decoding path parameters on the server.

PathPairField

class PathPairField<A, B>(val fieldA: PathField<A>, val fieldB: PathField) : KovenPairField<A, B> , PathField<KovenPair<A, B>>

A path field that combines two other path fields.

PathParams

data class PathParams(val data: Map<String, String> = emptyMap()) : Map<String, String>

A wrapper for path parameters.

QueryField

interface QueryField<T> : KovenField<T>

Interface for decoding query parameters on the server.

QueryPairField

class QueryPairField<A, B>(val fieldA: QueryField<A>, val fieldB: QueryField) : KovenPairField<A, B> , QueryField<KovenPair<A, B>>

A query field that combines two other query fields.

QueryParams

class QueryParams(data: Map<String, List<String>> = emptyMap()) : Map<String, List<String>>

A wrapper for query parameters that supports multiple values.

Redirect

object Redirect : HeaderField<String>

A header field for HTTP redirection.

SameSite

enum SameSite : Enum<SameSite>

The SameSite attribute of the cookie.

Functions

and

infix fun <A, B> A.and(other: B): KovenPair<A, B>

Creates a KovenPair from two values.

infix fun <A, B> CookieField<A>.and(other: CookieField): CookiePairField<A, B>

Creates a pair of cookie fields as CookiePairField.

@JvmName(name = "andEmptyPathFieldLeft")

infix fun Empty.and(other: PathField): PathField

Creates a pair of path fields as PathPairField, optimizing for Empty on the left.

@JvmName(name = "andEmptyQueryFieldLeft")

infix fun Empty.and(other: QueryField): QueryField

Creates a pair of query fields as QueryPairField, optimizing for Empty on the left.

infix fun <A, B> HeaderField<A>.and(other: HeaderField): HeaderPairField<A, B>

Creates a pair of header fields as HeaderPairField.

@JvmName(name = "andEmptyPathFieldRight")

infix fun <A> PathField<A>.and(other: Empty): PathField<A>

Creates a pair of path fields as PathPairField, optimizing for Empty on the right.

infix fun <A, B> PathField<A>.and(other: PathField): PathPairField<A, B>

Creates a pair of path fields as PathPairField.

@JvmName(name = "andEmptyQueryFieldRight")

infix fun <A> QueryField<A>.and(other: Empty): QueryField<A>

Creates a pair of query fields as QueryPairField, optimizing for Empty on the right.

infix fun <A, B> QueryField<A>.and(other: QueryField): QueryPairField<A, B>

Creates a pair of query fields as QueryPairField.

bind

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.

flattenPair

fun KovenPair<*, *>?.flattenPair(): List<Any?>

Flattens a KovenPair into a list of its constituent elements.

optional

fun <T> CookieField<T>.optional(): CookieField<T?>

Marks a cookie field as optional.

fun <T> HeaderField<T>.optional(): HeaderField<T?>

Marks a header field as optional.

fun <T> PathField<T>.optional(): PathField<T?>

Marks a path field as optional.

fun <T> QueryField<T>.optional(): QueryField<T?>

Marks a query field as optional.