# PreferencesSerializer

Artifact: [androidx.datastore:datastore-preferences-core](https://developer.android.com/jetpack/androidx/releases/datastore) [View Source](https://cs.android.com/search?q=file:androidx/datastore/preferences/core/PreferencesSerializer.+class:androidx.datastore.preferences.core.PreferencesSerializer) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.1.0)

*** ** * ** ***

Common/AllAndroid/JVMNative/C/iOSJavaScript
- Cmn

  ```
  object PreferencesSerializer : OkioSerializer<Preferences>
  ```

*** ** * ** ***

Proto based serializer for Preferences. Can be used to manually create `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStore` using the `https://developer.android.com/reference/kotlin/androidx/datastore/core/DataStoreFactory#create(androidx.datastore.core.Storage,androidx.datastore.core.handlers.ReplaceFileCorruptionHandler,kotlin.collections.List,kotlinx.coroutines.CoroutineScope)` function.

## Summary

| ### Public functions |
|---|---|---|
| `open suspend https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/Preferences` | `https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/PreferencesSerializer#readFrom(okio.BufferedSource)(source: https://lysine.dev/okio/3.x/okio/okio/-buffered-source/index.html)` Unmarshal object from source. | Cmn android N JS |
| `open suspend https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/PreferencesSerializer#writeTo(androidx.datastore.preferences.core.Preferences,okio.BufferedSink)(t: https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/Preferences, sink: https://lysine.dev/okio/3.x/okio/okio/-buffered-sink/index.html)` Marshal object to a Sink. | Cmn android N JS |

| ### Public properties |
|---|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/Preferences` | `https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/PreferencesSerializer#defaultValue()` Value to return if there is no data on disk. | Cmn android N JS |

## Public functions

### readFrom

Cmn android N JS

```
open suspend fun readFrom(source: BufferedSource): Preferences
```

Unmarshal object from source.

| Parameters |
|---|---|
| `source: https://lysine.dev/okio/3.x/okio/okio/-buffered-source/index.html` | the BufferedSource with the data to deserialize |

| Throws |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/datastore/core/CorruptionException` | if the data from `https://developer.android.com/reference/kotlin/androidx/datastore/core/okio/OkioSerializer#readFrom(okio.BufferedSource)` is corrupted and/or unparseable, e.g. `InvalidProtocolBufferException` when the type `https://developer.android.com/reference/kotlin/androidx/datastore/core/okio/OkioSerializer` is a protobuf message and it is corrupted. Other unrecoverable `https://developer.android.com/reference/kotlin/androidx/datastore/core/IOException` from the file system should not be thrown as `https://developer.android.com/reference/kotlin/androidx/datastore/core/CorruptionException`. |

### writeTo

Cmn android N JS Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.1.0)

```
open suspend fun writeTo(t: Preferences, sink: BufferedSink): Unit
```

Marshal object to a Sink.

| Parameters |
|---|---|
| `t: https://developer.android.com/reference/kotlin/androidx/datastore/preferences/core/Preferences` | the data to write to output |
| `sink: https://lysine.dev/okio/3.x/okio/okio/-buffered-sink/index.html` | the BufferedSink to serialize data to |

## Public properties

### defaultValue

Cmn android N JS Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/datastore#1.1.0)

```
open val defaultValue: Preferences
```

Value to return if there is no data on disk.