kord-common/dev.kord.common.entity.optional

Package-level declarations

Types

Optional

@Serializable(with = Optional.OptionalSerializer::class)

sealed class Optional<out T>

Represents a value that encapsulates all three possible states of a value in the Discord API. Specifically:

OptionalBoolean

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

sealed class OptionalBoolean

Represents a value that encapsulate the optional and value state of a Boolean in the Discord API. Specifically:

OptionalDouble

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

sealed class OptionalDouble

Represents a value that encapsulate the optional and value state of an Int in the Discord API. Specifically:

OptionalInt

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

sealed class OptionalInt

Represents a value that encapsulate the optional and value state of an Int in the Discord API. Specifically:

OptionalLong

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

sealed class OptionalLong

Represents a value that encapsulate the optional and value state of a Long in the Discord API. Specifically:

OptionalSnowflake

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

sealed class OptionalSnowflake

Represents a value that encapsulate a Snowflake's optional and value state in the Discord API.

Properties

asNullable

val OptionalBoolean?.asNullable: Boolean?

returns null if this is null, calls OptionalBoolean.asNullable otherwise.

val OptionalDouble?.asNullable: Double?

returns null if this is null, calls OptionalDouble.asNullable otherwise.

val OptionalInt?.asNullable: Int?

returns null if this is null, calls OptionalInt.asNullable otherwise.

val OptionalLong?.asNullable: Long?

returns null if this is null, calls OptionalLong.asNullable otherwise.

missingIfNull

val Snowflake?.missingIfNull: OptionalSnowflake

value

val OptionalBoolean?.value: Boolean?

returns null if this is null or OptionalBoolean.Missing, calls OptionalBoolean.Value.value otherwise.

val OptionalDouble?.value: Double?

returns null if this is null or OptionalDouble.Missing, calls OptionalDouble.Value.value otherwise.

val OptionalInt?.value: Int?

returns null if this is null or OptionalInt.Missing, calls OptionalInt.Value.value otherwise.

val OptionalLong?.value: Long?

returns null if this is null, calls OptionalLong.asNullable otherwise.

val OptionalSnowflake?.value: Snowflake?

returns null if this is null or OptionalSnowflake.Missing, calls OptionalSnowflake.Value.value otherwise.

Functions

coerceToMissing

fun <T : Any> Optional<T?>.coerceToMissing(): Optional<T>

filterInstanceOfList

inline fun <R> Optional<List<*>>.filterInstanceOfList(): Optional<List<R>>

filterList

inline fun <E> Optional<List<E>>.filterList(mapper: (E) -> Boolean): Optional<List<E>>

first

inline fun <E> Optional<List<E>>.first(predicate: (E) -> Boolean): E

firstOrNull

inline fun <E> Optional<List<E>>.firstOrNull(predicate: (E) -> Boolean): E?

flatMap

inline fun <E : Any, T : Any> Optional<E>.flatMap(mapper: (E) -> Optional<T>): Optional<T>

Applies the mapper to the optional if it is a Value, returns the same optional otherwise.

getOrThrow

fun OptionalDouble?.getOrThrow(): Double

fun OptionalInt?.getOrThrow(): Int

returns the value of the optional or throws a IllegalStateException if the optional doesn't contain a value or is null.

map

inline fun OptionalDouble.map(mapper: (Double) -> Double): OptionalDouble

inline fun OptionalInt.map(mapper: (Int) -> Int): OptionalInt

inline fun <T : Any> OptionalSnowflake.map(mapper: (Snowflake) -> T): Optional<T>

@JvmName(name = "mapNullableOptional")

inline fun <E : Any, T : Any> Optional<E?>.map(mapper: (E) -> T): Optional<T?>

inline fun <E : Any, T : Any> Optional<E>.map(mapper: (E) -> T): Optional<T>

mapCopy

fun <T> Optional<MutableList<T>>.mapCopy(): Optional<List<T>>

@JvmName(name = "mapCopyOfMap")

fun <K, V> Optional<MutableMap<K, V>>.mapCopy(): Optional<Map<K, V>>

mapList

@JvmName(name = "mapNullableList")

inline fun <E, T> Optional<List<E>?>.mapList(mapper: (E) -> T): Optional<List<T>?>

inline fun <E, T> Optional<List<E>>.mapList(mapper: (E) -> T): Optional<List<T>>

mapNotNull

inline fun <E : Any, T> Optional<E?>.mapNotNull(mapper: (E) -> T): Optional<T?>

mapNullable

inline fun <E, T> Optional<E>.mapNullable(mapper: (E) -> T): Optional<T?>

mapSnowflake

@JvmName(name = "mapNullableSnowflake")

inline fun <E : Any> Optional<E?>.mapSnowflake(mapper: (E) -> Snowflake): OptionalSnowflake

inline fun <E : Any> Optional<E>.mapSnowflake(mapper: (E) -> Snowflake): OptionalSnowflake

mapValues

inline fun <K, V, R> Optional<Map<K, V>>.mapValues(mapper: (Map.Entry<K, V>) -> R): Optional<Map<K, R>>

optional

fun <T> T?.optional(): Optional<T?>

fun <T : Any> T.optional(): Optional.Value<T>

fun Boolean.optional(): OptionalBoolean.Value

fun Long?.optional(): OptionalLong

optionalDouble

fun Double.optionalDouble(): OptionalDouble.Value

optionalInt

fun Int.optionalInt(): OptionalInt.Value

optionalSnowflake

fun Snowflake.optionalSnowflake(): OptionalSnowflake.Value

@JvmName(name = "optionalNullable")

fun Snowflake?.optionalSnowflake(): OptionalSnowflake.Value?

orElse

fun OptionalBoolean?.orElse(default: Boolean): Boolean

returns default if this is null, calls OptionalBoolean.asNullable otherwise.

fun OptionalDouble?.orElse(default: Int): Int

returns default if this is null, calls OptionalDouble.asNullable otherwise.

fun OptionalInt?.orElse(default: Int): Int

returns default if this is null, calls OptionalInt.asNullable otherwise.

fun OptionalLong?.orElse(default: Long): Long

returns default if this is null, calls OptionalLong.asNullable otherwise.

orEmpty

fun <E> Optional<List<E>>.orEmpty(): List<E>

fun <E> Optional<Set<E>>.orEmpty(): Set<E>

switchOnMissing

fun <T : Any> Optional<T>.switchOnMissing(value: T): Optional<T>

fun <T : Any> Optional<T>.switchOnMissing(value: Optional<T>): Optional<T>

toPrimitive

fun Optional<Boolean>.toPrimitive(): OptionalBoolean

unwrap

inline fun <T, R : Any> Optional<T>.unwrap(mapper: (T) -> R): R?