library/xyz.malefic.koven.contract.field/Empty

Empty

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

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

Properties

field

open override val field: String

fields

open override val fields: List<String>

The fields for this header field.

name

open override val name: String

Display name for this field, derived from fields.

Functions

and

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.

clear

open fun clear(): Cookie

Creates an empty Cookie with the properties defined in this field for the purpose of clearing an already-existent cookie.

create

open infix fun create(value: String): Cookie

Creates a Cookie using the properties defined in this field.

open fun create(value: Empty): QueryParams

Creates a QueryParams object from the given value.

createCookies

open fun createCookies(value: Empty): Cookies

Creates a Cookies object from the given value.

createHeaders

open fun createHeaders(value: Empty): Headers

Creates a Headers object from the given value.

createPath

open fun createPath(value: Empty): PathParams

Creates a PathParams object from the given value.

decode

context(_: Raise<Issue>)
open infix override fun decode(value: Map<String, String>): Empty

context(_: Raise<Issue>)
open override fun decode(headers: Headers): Empty

context(_: Raise<Issue>)
open override fun decode(params: QueryParams): Empty

domain

open fun domain(): String?

The domain for which the cookie is valid.

encodeCookies

open override fun encodeCookies(value: Empty): List<Cookie>

encodeHeaders

open override fun encodeHeaders(value: Empty): Map<String, List<String>>

encodePath

open override fun encodePath(value: Empty): Map<String, String>

encodeQuery

open override fun encodeQuery(value: Empty): Map<String, List<String>>

flatten

open override fun flatten(): List<Nothing>

Flattens the HeaderField into its constituent fields.

isHttpOnly

open fun isHttpOnly(): Boolean

Whether this cookie is intended to be server-side only.

maxAge

open fun maxAge(): Long?

The maximum age of the cookie in seconds.

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.

path

open fun path(): String?

The path for which the cookie is valid.

sameSite

open fun sameSite(): SameSite

The SameSite attribute of the cookie.

secure

open fun secure(): Boolean

Whether the cookie should only be sent over secure connections.