OkioSerializer
Known direct subclasses
PreferencesSerializer

Proto based serializer for Preferences.

The OkioSerializer determines the on-disk format and API for accessing it.

The type T MUST be immutable. Mutable types will result in broken DataStore functionality.

Summary

Public functions
suspend T

Unmarshal object from source.
Cmn
suspend Unit
writeTo(t: T, sink: BufferedSink)

Marshal object to a Sink.
Cmn

Public properties
T

Value to return if there is no data on disk.
Cmn

Public functions

readFrom

Cmn 
suspend fun readFrom(source: BufferedSource): T

Unmarshal object from source.

Parameters
source: BufferedSource

the BufferedSource with the data to deserialize
Throws
androidx.datastore.core.CorruptionException

if the data from input is corrupted and/or unparseable, e.g. InvalidProtocolBufferException when the type T is a protobuf message and it is corrupted. Other unrecoverable IOException from the file system should not be thrown as CorruptionException.

writeTo

Cmn
Added in 1.1.0
suspend fun writeTo(t: T, sink: BufferedSink): Unit

Marshal object to a Sink.

Parameters
t: T

the data to write to output
sink: BufferedSink

the BufferedSink to serialize data to

Public properties

defaultValue

Cmn
Added in 1.1.0
val defaultValue: T

Value to return if there is no data on disk.