Coroutines

The coroutines library adds extension functions to convert the Prefrence into Flow and Collector objects. It also provides a few extra APIs to perform commit() operations with suspend functions.

Note: This library is not accessible from Java sources.

Getting the dependency

implementation "com.frybits.rx.preferences:coroutines:2.0.1"

Usage

Preference as a Flow

val rxSharedPreferences = sharedPreferences.asRxSharedPreferences()

val scope = CoroutineScope(Dispatchers.Main.immediate)

val usernamePref: Preference<String?> = rxSharedPreferences.getString("username")

val usernameFlow: Flow<String?> = usernamePref.asFlow()

usernameFlow.onEach { name ->
    println(name) // Immediately emits 'null'
}.launchIn(scope)

usernamePref.value = "bob"
// Output from flow => "bob"

Preference as a Collector

val rxSharedPreferences = sharedPreferences.asRxSharedPreferences()

val scope = CoroutineScope(Dispatchers.Main.immediate)

val featureEnabledPref: Preference<Boolean> = rxSharedPreferences.getBoolean("somePref")

val featureEnabledCollector = featureEnabledPref.asCollector(committing = true) // Commit every emit

val checkedButtonFlow = channelFlow { 
    val onChangedListener = OnCheckedChangeListener { _, isChecked ->
        trySendBlocking(isChecked)
    }
    button.setOnCheckedChangeListener(onChangedListener)
    awaitClose { button.setOnCheckedChangeListener(null) }
}

scope.launch {
    // Every emit from the flow will be stored to the preference
    checkedButtonFlow.collect(featureEnabledCollector)
}