# RxDataStoreBuilder

Artifact: [androidx.datastore:datastore-rxjava2](https://developer.android.com/jetpack/androidx/releases/datastore) [View Source](https://cs.android.com/search?q=file:androidx/datastore/rxjava2/RxDataStoreBuilder.kt+class:androidx.datastore.rxjava2.RxDataStoreBuilder) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

*** ** * ** ***


```
public final class RxDataStoreBuilder<T extends Object>
```

<br />

*** ** * ** ***

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

## Summary

| ### Public constructors |
|---|
| `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#RxDataStoreBuilder(java.util.concurrent.Callable,androidx.datastore.core.Serializer)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Callable.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/File.html> produceFile, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/Serializer<@https://developer.android.com/reference/androidx/annotation/NonNull T> serializer )` Create a RxDataStoreBuilder with the callable which returns the File that DataStore acts on. |
| `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#RxDataStoreBuilder(android.content.Context,kotlin.String,androidx.datastore.core.Serializer)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html fileName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/Serializer<@https://developer.android.com/reference/androidx/annotation/NonNull T> serializer )` Create a RxDataStoreBuilder with the Context and name from which to derive the DataStore file. |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#addDataMigration(androidx.datastore.core.DataMigration)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/DataMigration<@https://developer.android.com/reference/androidx/annotation/NonNull T> dataMigration)` Add a DataMigration to the Datastore. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#addRxDataMigration(androidx.datastore.rxjava2.RxDataMigration)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataMigration<@https://developer.android.com/reference/androidx/annotation/NonNull T> rxDataMigration)` Add an RxDataMigration to the DataStore. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStore<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#build()()` Build the DataStore. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#setCorruptionHandler(androidx.datastore.core.handlers.ReplaceFileCorruptionHandler)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<@https://developer.android.com/reference/androidx/annotation/NonNull T> corruptionHandler )` Sets the corruption handler to install into the DataStore. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | `https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder#setIoScheduler(io.reactivex.Scheduler)(@https://developer.android.com/reference/androidx/annotation/NonNull https://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Scheduler.html ioScheduler)` Set the Scheduler on which to perform IO and transform operations. |

## Public constructors

### RxDataStoreBuilder

```
public <T extends Object> RxDataStoreBuilder(
    @NonNull Callable<@NonNull File> produceFile,
    @NonNull Serializer<@NonNull T> serializer
)
```

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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Callable.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/io/File.html> 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. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/Serializer<@https://developer.android.com/reference/androidx/annotation/NonNull T> serializer` | the serializer for the type that this DataStore acts on. |

### RxDataStoreBuilder

```
public <T extends Object> RxDataStoreBuilder(
    @NonNull Context context,
    @NonNull String fileName,
    @NonNull Serializer<@NonNull T> serializer
)
```

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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | the context from which we retrieve files directory. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html fileName` | the filename relative to Context.applicationContext.filesDir that DataStore acts on. The File is obtained from `https://developer.android.com/reference/androidx/datastore/package-summary#(android.content.Context).dataStoreFile(kotlin.String)`. It is created in the "/datastore" subdirectory. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/Serializer<@https://developer.android.com/reference/androidx/annotation/NonNull T> serializer` | the serializer for the type that this DataStore acts on. |

## Public methods

### addDataMigration

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

```
public final @NonNull RxDataStoreBuilder<@NonNull T> addDataMigration(@NonNull DataMigration<@NonNull T> dataMigration)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/DataMigration<@https://developer.android.com/reference/androidx/annotation/NonNull T> dataMigration` | the migration to add |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | this |

### addRxDataMigration

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

```
public final @NonNull RxDataStoreBuilder<@NonNull T> addRxDataMigration(@NonNull RxDataMigration<@NonNull T> rxDataMigration)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataMigration<@https://developer.android.com/reference/androidx/annotation/NonNull T> rxDataMigration` | the migration to add. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | this |

### build

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

```
public final @NonNull RxDataStore<@NonNull T> build()
```

Build the DataStore.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStore<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | the DataStore with the provided parameters |

### setCorruptionHandler

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

```
public final @NonNull RxDataStoreBuilder<@NonNull T> setCorruptionHandler(
    @NonNull ReplaceFileCorruptionHandler<@NonNull T> corruptionHandler
)
```

Sets the corruption handler to install into the DataStore.

This parameter is optional and defaults to no corruption handler.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/core/handlers/ReplaceFileCorruptionHandler<@https://developer.android.com/reference/androidx/annotation/NonNull T> corruptionHandler` |   |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | this |

### setIoScheduler

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.0.0)

```
public final @NonNull RxDataStoreBuilder<@NonNull T> 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 |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Scheduler.html ioScheduler` | the scheduler on which IO and transform operations are run |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/datastore/rxjava2/RxDataStoreBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull T>` | this |