IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

OptionalVariable.Undefined

object OptionalVariable.Undefined : OptionalVariable

An implementation of OptionalVariable representing an "undefined" value.

This value will be excluded entirely from the serial form.

Summary

Public functions
`open String`	`toString()` Returns a string representation of this object, useful for debugging.
`open Nothing?`	`valueOrNull()` Unconditionally returns `null`.
`open Nothing`	`valueOrThrow()` Unconditionally throws an exception.

Public functions

toString

open fun toString(): String

Returns a string representation of this object, useful for debugging.

The string representation is not guaranteed to be stable and may change without notice at any time. Therefore, the only recommended usage of the returned string is debugging and/or logging. Namely, parsing the returned string or storing the returned string in non-volatile storage should generally be avoided in order to be robust in case that the string representation changes.

Returns
`String`	a string representation of this object.

valueOrNull

open fun valueOrNull(): Nothing?

Unconditionally returns null.

valueOrThrow

open fun valueOrThrow(): Nothing

Unconditionally throws an exception.