settings-datastore

2.1.0-beta02

settings-datastore/de.charlex.settings.datastore

Package-level declarations

Types

IDataStoreEnumPreference

interface IDataStoreEnumPreference<T>

IDataStorePreference

interface IDataStorePreference<T>

SecurityProvider

interface SecurityProvider

SettingsDataStore

interface SettingsDataStore

SettingsDataStoreImpl

class SettingsDataStoreImpl : SettingsDataStore, SecurityProvider

SettingsDataStoreInMemoryImpl

class SettingsDataStoreInMemoryImpl : SettingsDataStore, SecurityProvider

Functions

booleanPreference

fun booleanPreference(name: String, defaultValue: Boolean): IDataStorePreference<Boolean>

@JvmName(name = "booleanNullablePreference")

fun booleanPreference(name: String, defaultValue: Boolean?): IDataStorePreference<Boolean?>

fun SettingsDataStore.Companion.create(context: Context, name: String = "settings.preferences_pb", migrations: List<DataMigration<Preferences>> = listOf(), corruptionHandler: ReplaceFileCorruptionHandler<Preferences>? = null, scope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob()), security: Security = NoOpSecurity): SettingsDataStore

fun SettingsDataStore.Companion.create(name: String = "settings.preferences_pb", migrations: List<DataMigration<Preferences>> = listOf(), corruptionHandler: ReplaceFileCorruptionHandler<Preferences>? = null, scope: CoroutineScope = CoroutineScope(Dispatchers.IO + SupervisorJob()), security: Security = NoOpSecurity): SettingsDataStore

createDataStore

fun createDataStore(migrations: List<DataMigration<Preferences>>, corruptionHandler: ReplaceFileCorruptionHandler<Preferences>?, scope: CoroutineScope, producePath: () -> String): DataStore<Preferences>

doublePreference

fun doublePreference(name: String, defaultValue: Double): IDataStorePreference<Double>

@JvmName(name = "doubleNullablePreference")

fun doublePreference(name: String, defaultValue: Double?): IDataStorePreference<Double?>

fun <T : Enum<T>, U> enumPreference(name: String, defaultValue: T): IDataStoreEnumPreference<T>

floatPreference

fun floatPreference(name: String, defaultValue: Float): IDataStorePreference<Float>

@JvmName(name = "floatNullablePreference")

fun floatPreference(name: String, defaultValue: Float?): IDataStorePreference<Float?>

inline fun <T : Enum<T>> SettingsDataStore.get(pref: IDataStoreEnumPreference<T>): Flow<T>

fun intPreference(name: String, defaultValue: Int): IDataStorePreference<Int>

@JvmName(name = "intNullablePreference")

fun intPreference(name: String, defaultValue: Int?): IDataStorePreference<Int?>

fun longPreference(name: String, defaultValue: Long): IDataStorePreference<Long>

@JvmName(name = "longNullablePreference")

fun longPreference(name: String, defaultValue: Long?): IDataStorePreference<Long?>

stringPreference

fun stringPreference(name: String, defaultValue: String): IDataStorePreference<String>

@JvmName(name = "stringNullablePreference")

fun stringPreference(name: String, defaultValue: String?): IDataStorePreference<String?>

stringSetPreference

fun stringSetPreference(name: String, defaultValue: Set<String>): IDataStorePreference<Set<String>>

@JvmName(name = "stringSetNullablePreference")

fun stringSetPreference(name: String, defaultValue: Set<String>?): IDataStorePreference<Set<String>?>