preferences/io.github.jdbenitez94.criollo.kmp.foundation.kryptostore.preferences

Package-level declarations

Properties

const val PREFERENCES_PB_EXTENSION: String

AndroidX Preferences DataStore requires the .preferences_pb file extension (REQ-STO-07).

Functions

fun createEncryptedPreferencesDataStore(storage: Storage<Preferences>, migrations: List<DataMigration<Preferences>> = emptyList(), corruptionHandler: ReplaceFileCorruptionHandler<Preferences>? = null, registry: StoreRegistry? = null): DataStore<Preferences>

Encrypted Preferences DataStore over caller-supplied storage.

fun createEncryptedPreferencesDataStore(cipher: Cipher, producePath: () -> Path, options: EncryptedStoreOptions = EncryptedStoreOptions(), migrations: List<DataMigration<Preferences>> = emptyList(), corruptionHandler: ReplaceFileCorruptionHandler<Preferences>? = null, registry: StoreRegistry? = null): DataStore<Preferences>

File-backed encrypted Preferences DataStore (Okio). Path must end with .preferences_pb.

createEncryptedPreferencesDataStoreLocalStorage

expect fun createEncryptedPreferencesDataStoreLocalStorage(cipher: Cipher, name: String, options: EncryptedStoreOptions = EncryptedStoreOptions().apply { storeName = name }, migrations: List<DataMigration<Preferences>> = emptyList()): DataStore<Preferences>

Web encrypted prefs → localStorage.

actual fun createEncryptedPreferencesDataStoreLocalStorage(cipher: ERROR CLASS: Symbol not found for Cipher, name: String, options: ERROR CLASS: Symbol not found for EncryptedStoreOptions, migrations: List<ERROR CLASS: Symbol not found for DataMigration<ERROR CLASS: Symbol not found for Preferences>>): ERROR CLASS: Symbol not found for DataStore<ERROR CLASS: Symbol not found for Preferences>

actual fun createEncryptedPreferencesDataStoreLocalStorage(cipher: Cipher, name: String, options: EncryptedStoreOptions, migrations: List<DataMigration<Preferences>>): DataStore<Preferences>

Web encrypted prefs → localStorage.

createPlainPreferencesDataStore

fun createPlainPreferencesDataStore(producePath: () -> Path, migrations: List<DataMigration<Preferences>> = emptyList(), corruptionHandler: ReplaceFileCorruptionHandler<Preferences>? = null): DataStore<Preferences>

Plain (unencrypted) Preferences DataStore on a file path. Path must end with .preferences_pb. Readable without a Cipher.

createPlainPreferencesDataStoreLocalStorage

expect fun createPlainPreferencesDataStoreLocalStorage(name: String, migrations: List<DataMigration<Preferences>> = emptyList()): DataStore<Preferences>

Web plain prefs → localStorage.

actual fun createPlainPreferencesDataStoreLocalStorage(name: String, migrations: List<ERROR CLASS: Symbol not found for DataMigration<ERROR CLASS: Symbol not found for Preferences>>): ERROR CLASS: Symbol not found for DataStore<ERROR CLASS: Symbol not found for Preferences>

actual fun createPlainPreferencesDataStoreLocalStorage(name: String, migrations: List<DataMigration<Preferences>>): DataStore<Preferences>

Web plain prefs → localStorage.

encryptedPreferencesSerializer

fun encryptedPreferencesSerializer(cipher: Cipher, options: EncryptedStoreOptions = EncryptedStoreOptions()): EncryptedPreferencesSerializer

Builds an EncryptedPreferencesSerializer for custom Storage (e.g. WebLocalStorage).

requirePreferencesPbExtension

fun Path.requirePreferencesPbExtension(): Path