← Back to Kairo Docs|API Reference (Dokka)

kairo-optional/kairo.optional/Required

Required

sealed class Required<out T : Any> : OptionalBase<T>

Like Optional but without a Null variant. Use when the value must be non-null if present. Useful for required fields in JSON Merge Patch.

Inheritors

Types

object Companion

data object Missing : Required<Nothing>

The value was absent from the JSON. Treat as "do not modify".

data class Value<T : Any>(val value: T) : Required<T>

The value was present and non-null in the JSON.

Properties

abstract val isSpecified: Boolean

Functions

abstract override fun getOrThrow(): T

fun <T : Any> Required<T>.ifSpecified(block: (T) -> Unit)

Runs block for Required.Value, skips Required.Missing.

fun <T : Any, R : Any> Required<T>.transform(block: (T) -> R): Required<R>

Applies block to the inner value, preserving Required.Missing state.