RxPreferenceDataStoreBuilder

Artifact: androidx.datastore:datastore-preferences-rxjava3

Added in 1.0.0

Kotlin |Java

public final class RxPreferenceDataStoreBuilder

Builder for a Preferences RxDataStore that works on a single process.

Summary

Public constructors
`RxPreferenceDataStoreBuilder(@NonNull Callable<@NonNull File> produceFile)` Create a RxPreferenceDataStoreBuilder with the callable which returns the File that DataStore acts on.
`RxPreferenceDataStoreBuilder( @NonNull Context context, @NonNull String name )` Create a RxPreferenceDataStoreBuilder with the Context and name from which to derive the DataStore file.

Public methods
`final @NonNull RxPreferenceDataStoreBuilder`	`addDataMigration( @NonNull DataMigration<@NonNull Preferences> dataMigration )` Add a DataMigration to the Datastore.
`final @NonNull RxPreferenceDataStoreBuilder`	`addRxDataMigration( @NonNull RxDataMigration<@NonNull Preferences> rxDataMigration )` Add an RxDataMigration to the DataStore.
`final @NonNull RxDataStore<@NonNull Preferences>`	`build()` Build the DataStore.
`final @NonNull RxPreferenceDataStoreBuilder`	`setCorruptionHandler( @NonNull ReplaceFileCorruptionHandler<@NonNull Preferences> corruptionHandler )` Sets the corruption handler to install into the DataStore.
`final @NonNull RxPreferenceDataStoreBuilder`	`setIoScheduler(@NonNull Scheduler ioScheduler)` Set the Scheduler on which to perform IO and transform operations.

Public constructors

RxPreferenceDataStoreBuilder

Added in 1.0.0

public RxPreferenceDataStoreBuilder(@NonNull Callable<@NonNull File> produceFile)

Create a RxPreferenceDataStoreBuilder with the callable which returns the File that DataStore acts on. The user is responsible for ensuring that there is never more than one DataStore acting on a file at a time.

Parameters
`@NonNull Callable<@NonNull File> produceFile`	Function which returns the file that the new DataStore will act on. The function must return the same path every time. No two instances of DataStore should act on the same file at the same time.

RxPreferenceDataStoreBuilder

Added in 1.0.0

public RxPreferenceDataStoreBuilder(
    @NonNull Context context,
    @NonNull String name
)

Create a RxPreferenceDataStoreBuilder with the Context and name from which to derive the DataStore file. The file is generated by calling File(context.filesDir, "datastore/" + name + ".preferences_pb"). The user is responsible for ensuring that there is never more than one DataStore acting on a file at a time.

Parameters
`@NonNull Context context`	the context from which we retrieve files directory.
`@NonNull String name`	the filename relative to Context.filesDir that DataStore acts on. The File is obtained by calling File(this.filesDir, "datastore/$name.preferences_pb"). No two instances of DataStore should act on the same file at the same time.

Public methods

addDataMigration

Added in 1.0.0

public final @NonNull RxPreferenceDataStoreBuilder addDataMigration(
    @NonNull DataMigration<@NonNull Preferences> dataMigration
)

Add a DataMigration to the Datastore. Migrations are run in the order they are added.

Parameters
`@NonNull DataMigration<@NonNull Preferences> dataMigration`	the migration to add

Returns
`@NonNull RxPreferenceDataStoreBuilder`	this

addRxDataMigration

Added in 1.0.0

public final @NonNull RxPreferenceDataStoreBuilder addRxDataMigration(
    @NonNull RxDataMigration<@NonNull Preferences> rxDataMigration
)

Add an RxDataMigration to the DataStore. Migrations are run in the order they are added.

Parameters
`@NonNull RxDataMigration<@NonNull Preferences> rxDataMigration`	the migration to add.

Returns
`@NonNull RxPreferenceDataStoreBuilder`	this

build

Added in 1.0.0

public final @NonNull RxDataStore<@NonNull Preferences> build()

Build the DataStore.

Returns
`@NonNull RxDataStore<@NonNull Preferences>`	the DataStore with the provided parameters

Throws
`kotlin.IllegalStateException`	if serializer is not set or if neither produceFile not context and name are set.

setCorruptionHandler

Added in 1.0.0

public final @NonNull RxPreferenceDataStoreBuilder setCorruptionHandler(
    @NonNull ReplaceFileCorruptionHandler<@NonNull Preferences> corruptionHandler
)

Sets the corruption handler to install into the DataStore.

This parameter is optional and defaults to no corruption handler.

Parameters
`@NonNull ReplaceFileCorruptionHandler<@NonNull Preferences> corruptionHandler`	the ReplaceFileCorruptionHandler to install

Returns
`@NonNull RxPreferenceDataStoreBuilder`	this

setIoScheduler

Added in 1.0.0

public final @NonNull RxPreferenceDataStoreBuilder setIoScheduler(@NonNull Scheduler ioScheduler)

Set the Scheduler on which to perform IO and transform operations. This is converted into a CoroutineDispatcher before being added to DataStore.

This parameter is optional and defaults to Schedulers.io().

Parameters
`@NonNull Scheduler ioScheduler`	the scheduler on which IO and transform operations are run

Returns
`@NonNull RxPreferenceDataStoreBuilder`	this