← Back to Kairo Docs|API Reference (Dokka)

kairo-optional/kairo.optional/Optional

Optional

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

Kairo Optionals can be used to differentiate between missing and null values. This comes in especially handy for RFC 7396 (JSON Merge Patch).

Inheritors

Types

object Companion

data object Missing : Optional<Nothing>

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

data object Null : Optional<Nothing>

The value was explicitly set to null in the JSON. Treat as "clear this field".

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

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

Properties

abstract val isSpecified: Boolean

Functions

abstract fun getOrThrow(): T?

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

Runs block for Optional.Null and Optional.Value, skips Optional.Missing. The block receives null for the Null variant.

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

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