PreferencesFileSerializer

Kotlin |Java

public static class PreferencesFileSerializer implements Serializer

Proto based serializer for Preferences. Can be used to manually create DataStore using the DataStoreFactory#create function.

Summary

Public fields
`static @NonNull PreferencesFileSerializer`	`INSTANCE`

Public methods
`@NonNull Preferences`	`getDefaultValue()` Value to return if there is no data on disk.
`@NonNull Preferences`	`readFrom(@NonNull InputStream input)` Unmarshal object from stream.
`void`	`writeTo(@NonNull Preferences t, @NonNull OutputStream output)` Marshal object to a stream.

public static @NonNull PreferencesFileSerializer INSTANCE

public @NonNull Preferences getDefaultValue()

Value to return if there is no data on disk.

public @NonNull Preferences readFrom(@NonNull InputStream input)

Unmarshal object from stream.

Parameters
`@NonNull InputStream input`	the InputStream 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`.

public void writeTo(@NonNull Preferences t, @NonNull OutputStream output)

Marshal object to a stream. Closing the provided OutputStream is a no-op.

Parameters
`@NonNull Preferences t`	the data to write to output
`@NonNull OutputStream output`	the OutputStream to serialize data to