kiscord-core/kiscord.api/Box

Box

@Serializable(with = Box.Serializer::class)

value class Box<out T>(source)

Box is generic container for type T, which can be marked as absent (empty). Behaves similarly to Java's Optional, but allows nullable types as well.

Primary usage is to mark properties in kotlinx.serialization as nullable and optional at the same time, to be able to serialize nulls when schema requires it (for example in many request bodies for patch/edit requests) and still have some "default" value (in this case Box.absent) to omit property in serialization process.

@Serializable
data class SomePojo(
    // Now we can omit property as it is optional,
    // but serialize nulls as-well.
    val property: Box<String?> = Box.absent
)

Constructors

fun Box()

Creates absent (empty) Box

Types

object Companion

open class Serializer<T>(valueSerializer: KSerializer<T>) : KSerializer<Box<T>>

Functions

open override fun toString(): String

Properties

val isAbsent: Boolean

val isPresent: Boolean

val value: T

Returns underlying value of type T or throws NoSuchElementException if this box is absent.

Extensions

infix inline fun <T : Any> Box<T?>.computeIfNull(another: () -> T): T

infix inline fun <T> Box<T>.getOr(another: T): T

infix inline fun <T> Box<T>.getOr(another: () -> T): T

infix inline fun <T, R> Box<T>.map(block: (T) -> R): Box<R>

infix inline fun <T> Box<T>.or(another: T): Box<T>

infix inline fun <T> Box<T>.or(another: Box<T>): Box<T>

infix inline fun <T> Box<T>.or(another: () -> T): Box<T>

val <T> Box<T>.orNull: T?