OkioSerializer.kt
/*
* Copyright 2022 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.datastore.core.okio
import okio.BufferedSink
import okio.BufferedSource
/**
* 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.
*
*/
public interface OkioSerializer<T> {
/**
* Value to return if there is no data on disk.
*/
public val defaultValue: T
/**
* Unmarshal object from source.
*
* @param source the BufferedSource with the data to deserialize
*/
public suspend fun readFrom(source: BufferedSource): T
/**
* Marshal object to a Sink.
*
* @param t the data to write to output
* @param sink the BufferedSink to serialize data to
*/
public suspend fun writeTo(t: T, sink: BufferedSink)
}