RxPreferenceDataStoreDelegateKt
public final class RxPreferenceDataStoreDelegateKt
Summary
Public methods |
|
|---|---|
static final @NonNull ReadOnlyProperty<@NonNull Context, @NonNull RxDataStore<@NonNull Preferences>> |
rxPreferencesDataStore(Creates a property delegate for a single process Preferences DataStore. |
Public methods
rxPreferencesDataStore
public static final @NonNull ReadOnlyProperty<@NonNull Context, @NonNull RxDataStore<@NonNull Preferences>> rxPreferencesDataStore(
@NonNull String name,
ReplaceFileCorruptionHandler<@NonNull Preferences> corruptionHandler,
@NonNull Function1<@NonNull Context, @NonNull List<@NonNull DataMigration<@NonNull Preferences>>> produceMigrations,
@NonNull Scheduler scheduler
)
Creates a property delegate for a single process Preferences DataStore. This should only be called once in a file (at the top level), and all usages of the DataStore should use a reference the same Instance. The receiver type for the property delegate must be an instance of Context.
This should only be used from a single application in a single classloader in a single process.
Example usage:
val Context.myRxDataStore by rxPreferencesDataStore("filename", serializer)
class SomeClass(val context: Context) {
fun update(): Single<Preferences> = context.myRxDataStore.updateDataAsync {...}
}
| Parameters | |
|---|---|
@NonNull String name |
The name of the preferences. The preferences will be stored in a file in the "datastore/" subdirectory in the application context's files directory and is generated using preferencesDataStoreFile. |
ReplaceFileCorruptionHandler<@NonNull Preferences> corruptionHandler |
The corruptionHandler is invoked if DataStore encounters a |
@NonNull Function1<@NonNull Context, @NonNull List<@NonNull DataMigration<@NonNull Preferences>>> produceMigrations |
produce the migrations. The ApplicationContext is passed in to these callbacks as a parameter. DataMigrations are run before any access to data can occur. Each producer and migration may be run more than once whether or not it already succeeded (potentially because another migration failed or a write to disk failed.) |
@NonNull Scheduler scheduler |
The scope in which IO operations and transform functions will execute. |
| Returns | |
|---|---|
@NonNull ReadOnlyProperty<@NonNull Context, @NonNull RxDataStore<@NonNull Preferences>> |
a property delegate that manages a datastore as a singleton. |