RxDataStoreBuilder

class RxDataStoreBuilder<T : Any>

Builder class for an RxDataStore that works on a single process.

Summary

Public constructors
<T : Any> RxDataStoreBuilder(
    produceFile: Callable<File>,
    serializer: Serializer<T>
)

Create a RxDataStoreBuilder with the callable which returns the File that DataStore acts on.
<T : Any> RxDataStoreBuilder(
    context: Context,
    fileName: String,
    serializer: Serializer<T>
)

Create a RxDataStoreBuilder with the Context and name from which to derive the DataStore file.

Public functions
RxDataStoreBuilder<T>
addDataMigration(dataMigration: DataMigration<T>)

Add a DataMigration to the Datastore.
RxDataStoreBuilder<T>
addRxDataMigration(rxDataMigration: RxDataMigration<T>)

Add an RxDataMigration to the DataStore.
RxDataStore<T>

Build the DataStore.
RxDataStoreBuilder<T>
setCorruptionHandler(
    corruptionHandler: ReplaceFileCorruptionHandler<T>
)

Sets the corruption handler to install into the DataStore.
RxDataStoreBuilder<T>
setIoScheduler(ioScheduler: Scheduler)

Set the Scheduler on which to perform IO and transform operations.

Public constructors

RxDataStoreBuilder

<T : Any> RxDataStoreBuilder(
    produceFile: Callable<File>,
    serializer: Serializer<T>
)

Create a RxDataStoreBuilder 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
produceFile: Callable<File>

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.
serializer: Serializer<T>

the serializer for the type that this DataStore acts on.

RxDataStoreBuilder

<T : Any> RxDataStoreBuilder(
    context: Context,
    fileName: String,
    serializer: Serializer<T>
)

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

Parameters
context: Context

the context from which we retrieve files directory.
fileName: String

the filename relative to Context.applicationContext.filesDir that DataStore acts on. The File is obtained from dataStoreFile. It is created in the "/datastore" subdirectory.
serializer: Serializer<T>

the serializer for the type that this DataStore acts on.

Public functions

addDataMigration

Added in 1.0.0
fun addDataMigration(dataMigration: DataMigration<T>): RxDataStoreBuilder<T>

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

Parameters
dataMigration: DataMigration<T>

the migration to add
Returns
RxDataStoreBuilder<T>

this

addRxDataMigration

Added in 1.0.0
fun addRxDataMigration(rxDataMigration: RxDataMigration<T>): RxDataStoreBuilder<T>

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

Parameters
rxDataMigration: RxDataMigration<T>

the migration to add.
Returns
RxDataStoreBuilder<T>

this

build

Added in 1.0.0
fun build(): RxDataStore<T>

Build the DataStore.

Returns
RxDataStore<T>

the DataStore with the provided parameters

setCorruptionHandler

Added in 1.0.0
fun setCorruptionHandler(
    corruptionHandler: ReplaceFileCorruptionHandler<T>
): RxDataStoreBuilder<T>

Sets the corruption handler to install into the DataStore.

This parameter is optional and defaults to no corruption handler.

Parameters
corruptionHandler: ReplaceFileCorruptionHandler<T>
Returns
RxDataStoreBuilder<T>

this

setIoScheduler

Added in 1.0.0
fun setIoScheduler(ioScheduler: Scheduler): RxDataStoreBuilder<T>

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
ioScheduler: Scheduler

the scheduler on which IO and transform operations are run
Returns
RxDataStoreBuilder<T>

this