viewmodel-savedstate/com.hoc081098.kmp.viewmodel.safe

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION])

annotation class DelicateSafeSavedStateHandleApi

Marks declarations in the com.hoc081098.kmp.viewmodel.safe that are delicate — they have limited use-case and shall be used with care in general code.

NonNullSavedStateHandleKey

class NonNullSavedStateHandleKey<T : Any>

Key for values stored in SavedStateHandle. The type of the value associated with this key is T (non-null)

NullableSavedStateHandleKey

class NullableSavedStateHandleKey<T : Any>

Key for values stored in SavedStateHandle. The type of the value associated with this key is T? (nullable, null is valid).

SafeSavedStateHandle

@JvmInline

value class SafeSavedStateHandle(val savedStateHandle: SavedStateHandle)

A wrapper of SavedStateHandle that provides type-safe access with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

Properties

safe

val SavedStateHandle.safe: SafeSavedStateHandle

Enables type-safe access to SavedStateHandle. You can use this with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

Functions

boolean

fun NonNullSavedStateHandleKey.Companion.boolean(key: String, defaultValue: Boolean): NonNullSavedStateHandleKey<Boolean>

fun NullableSavedStateHandleKey.Companion.boolean(key: String, defaultValue: Boolean? = null): NullableSavedStateHandleKey<Boolean>

booleanArray

fun NonNullSavedStateHandleKey.Companion.booleanArray(key: String, defaultValue: BooleanArray): NonNullSavedStateHandleKey<BooleanArray>

fun NullableSavedStateHandleKey.Companion.booleanArray(key: String, defaultValue: BooleanArray? = null): NullableSavedStateHandleKey<BooleanArray>

byte

fun NonNullSavedStateHandleKey.Companion.byte(key: String, defaultValue: Byte): NonNullSavedStateHandleKey<Byte>

fun NullableSavedStateHandleKey.Companion.byte(key: String, defaultValue: Byte? = null): NullableSavedStateHandleKey<Byte>

byteArray

fun NonNullSavedStateHandleKey.Companion.byteArray(key: String, defaultValue: ByteArray): NonNullSavedStateHandleKey<ByteArray>

fun NullableSavedStateHandleKey.Companion.byteArray(key: String, defaultValue: ByteArray? = null): NullableSavedStateHandleKey<ByteArray>

char

fun NonNullSavedStateHandleKey.Companion.char(key: String, defaultValue: Char): NonNullSavedStateHandleKey<Char>

fun NullableSavedStateHandleKey.Companion.char(key: String, defaultValue: Char? = null): NullableSavedStateHandleKey<Char>

charArray

fun NonNullSavedStateHandleKey.Companion.charArray(key: String, defaultValue: CharArray): NonNullSavedStateHandleKey<CharArray>

fun NullableSavedStateHandleKey.Companion.charArray(key: String, defaultValue: CharArray? = null): NullableSavedStateHandleKey<CharArray>

charSequence

fun NonNullSavedStateHandleKey.Companion.charSequence(key: String, defaultValue: CharSequence): NonNullSavedStateHandleKey<CharSequence>

fun NullableSavedStateHandleKey.Companion.charSequence(key: String, defaultValue: CharSequence? = null): NullableSavedStateHandleKey<CharSequence>

charSequenceArray

fun NonNullSavedStateHandleKey.Companion.charSequenceArray(key: String, defaultValue: Array<CharSequence?>): NonNullSavedStateHandleKey<Array<CharSequence?>>

fun NullableSavedStateHandleKey.Companion.charSequenceArray(key: String, defaultValue: Array<CharSequence?>? = null): NullableSavedStateHandleKey<Array<CharSequence?>>

charSequenceArrayList

fun NonNullSavedStateHandleKey.Companion.charSequenceArrayList(key: String, defaultValue: ArrayList<CharSequence?>): NonNullSavedStateHandleKey<ArrayList<CharSequence?>>

fun NullableSavedStateHandleKey.Companion.charSequenceArrayList(key: String, defaultValue: ArrayList<CharSequence?>? = null): NullableSavedStateHandleKey<ArrayList<CharSequence?>>

double

fun NonNullSavedStateHandleKey.Companion.double(key: String, defaultValue: Double): NonNullSavedStateHandleKey<Double>

fun NullableSavedStateHandleKey.Companion.double(key: String, defaultValue: Double? = null): NullableSavedStateHandleKey<Double>

doubleArray

fun NonNullSavedStateHandleKey.Companion.doubleArray(key: String, defaultValue: DoubleArray): NonNullSavedStateHandleKey<DoubleArray>

fun NullableSavedStateHandleKey.Companion.doubleArray(key: String, defaultValue: DoubleArray? = null): NullableSavedStateHandleKey<DoubleArray>

float

fun NonNullSavedStateHandleKey.Companion.float(key: String, defaultValue: Float): NonNullSavedStateHandleKey<Float>

fun NullableSavedStateHandleKey.Companion.float(key: String, defaultValue: Float? = null): NullableSavedStateHandleKey<Float>

floatArray

fun NonNullSavedStateHandleKey.Companion.floatArray(key: String, defaultValue: FloatArray): NonNullSavedStateHandleKey<FloatArray>

fun NullableSavedStateHandleKey.Companion.floatArray(key: String, defaultValue: FloatArray? = null): NullableSavedStateHandleKey<FloatArray>

getLiveData

fun <T : Any> SafeSavedStateHandle.getLiveData(key: NonNullSavedStateHandleKey<T>): LiveData<T>

fun <T : Any> SafeSavedStateHandle.getLiveData(key: NullableSavedStateHandleKey<T>): LiveData<T?>

int

fun NonNullSavedStateHandleKey.Companion.int(key: String, defaultValue: Int): NonNullSavedStateHandleKey<Int>

fun NullableSavedStateHandleKey.Companion.int(key: String, defaultValue: Int? = null): NullableSavedStateHandleKey<Int>

intArray

fun NonNullSavedStateHandleKey.Companion.intArray(key: String, defaultValue: IntArray): NonNullSavedStateHandleKey<IntArray>

fun NullableSavedStateHandleKey.Companion.intArray(key: String, defaultValue: IntArray? = null): NullableSavedStateHandleKey<IntArray>

intArrayList

fun NonNullSavedStateHandleKey.Companion.intArrayList(key: String, defaultValue: ArrayList<Int?>): NonNullSavedStateHandleKey<ArrayList<Int?>>

fun NullableSavedStateHandleKey.Companion.intArrayList(key: String, defaultValue: ArrayList<Int?>? = null): NullableSavedStateHandleKey<ArrayList<Int?>>

long

fun NonNullSavedStateHandleKey.Companion.long(key: String, defaultValue: Long): NonNullSavedStateHandleKey<Long>

fun NullableSavedStateHandleKey.Companion.long(key: String, defaultValue: Long? = null): NullableSavedStateHandleKey<Long>

longArray

fun NonNullSavedStateHandleKey.Companion.longArray(key: String, defaultValue: LongArray): NonNullSavedStateHandleKey<LongArray>

fun NullableSavedStateHandleKey.Companion.longArray(key: String, defaultValue: LongArray? = null): NullableSavedStateHandleKey<LongArray>

parcelable

fun <T : Parcelable> NonNullSavedStateHandleKey.Companion.parcelable(key: String, defaultValue: T): NonNullSavedStateHandleKey<T>

fun <T : Parcelable> NullableSavedStateHandleKey.Companion.parcelable(key: String, defaultValue: T? = null): NullableSavedStateHandleKey<T>

parcelableArray

inline fun <T : Parcelable> NonNullSavedStateHandleKey.Companion.parcelableArray(key: String, defaultValue: Array<T?>): NonNullSavedStateHandleKey<Array<T?>>

inline fun <T : Parcelable> NullableSavedStateHandleKey.Companion.parcelableArray(key: String, defaultValue: Array<T?>? = null): NullableSavedStateHandleKey<Array<T?>>

parcelableArrayList

fun <T : Parcelable> NonNullSavedStateHandleKey.Companion.parcelableArrayList(key: String, defaultValue: ArrayList<T?>): NonNullSavedStateHandleKey<ArrayList<T?>>

fun <T : Parcelable> NullableSavedStateHandleKey.Companion.parcelableArrayList(key: String, defaultValue: ArrayList<T?>? = null): NullableSavedStateHandleKey<ArrayList<T?>>

safe

inline fun <R> SavedStateHandle.safe(block: (SafeSavedStateHandle) -> R): R

Enables type-safe access to SavedStateHandle. You can use this with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

serializable

fun <T : JvmSerializable> NonNullSavedStateHandleKey.Companion.serializable(key: String, defaultValue: T): NonNullSavedStateHandleKey<T>

fun <T : JvmSerializable> NullableSavedStateHandleKey.Companion.serializable(key: String, defaultValue: T? = null): NullableSavedStateHandleKey<T>

short

fun NonNullSavedStateHandleKey.Companion.short(key: String, defaultValue: Short): NonNullSavedStateHandleKey<Short>

fun NullableSavedStateHandleKey.Companion.short(key: String, defaultValue: Short? = null): NullableSavedStateHandleKey<Short>

shortArray

fun NonNullSavedStateHandleKey.Companion.shortArray(key: String, defaultValue: ShortArray): NonNullSavedStateHandleKey<ShortArray>

fun NullableSavedStateHandleKey.Companion.shortArray(key: String, defaultValue: ShortArray? = null): NullableSavedStateHandleKey<ShortArray>

string

fun NonNullSavedStateHandleKey.Companion.string(key: String, defaultValue: String): NonNullSavedStateHandleKey<String>

fun NullableSavedStateHandleKey.Companion.string(key: String, defaultValue: String? = null): NullableSavedStateHandleKey<String>

stringArray

fun NonNullSavedStateHandleKey.Companion.stringArray(key: String, defaultValue: Array<String>): NonNullSavedStateHandleKey<Array<String>>

fun NullableSavedStateHandleKey.Companion.stringArray(key: String, defaultValue: Array<String?>? = null): NullableSavedStateHandleKey<Array<String?>>

stringArrayList

fun NonNullSavedStateHandleKey.Companion.stringArrayList(key: String, defaultValue: ArrayList<String?>): NonNullSavedStateHandleKey<ArrayList<String?>>

fun NullableSavedStateHandleKey.Companion.stringArrayList(key: String, defaultValue: ArrayList<String?>? = null): NullableSavedStateHandleKey<ArrayList<String?>>