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

CookieField

interface CookieField<T> : KovenField<T>

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

Inheritors

Types

Companion

object Companion

Properties

fields

open override val fields: List<String>

The field name(s) for this field.

name

abstract val name: String

Functions

and

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

Creates a pair of cookie fields as CookiePairField.

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.

createCookies

open fun createCookies(value: T): Cookies

Creates a Cookies object from the given value.

decode

context(_: Raise<Issue>)
abstract infix fun decode(cookies: Map<String, String>): T

domain

open fun domain(): String?

The domain for which the cookie is valid.

encodeCookies

abstract fun encodeCookies(value: T): List<Cookie>

flatten

open override fun flatten(): List<CookieField<*>>

Flattens the field 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.

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.