| /* |
| * Copyright 2020 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 |
| |
| import java.io.InputStream |
| import java.io.OutputStream |
| |
| /** |
| * The serializer determines the on-disk format and API for accessing it. |
| * |
| * The type T MUST be immutable. Mutable types will result in broken DataStore functionality. |
| * |
| * TODO(b/151635324): consider changing InputStream to File. |
| */ |
| public interface Serializer<T> { |
| |
| /** |
| * Value to return if there is no data on disk. |
| */ |
| public val defaultValue: T |
| |
| /** |
| * Unmarshal object from stream. |
| * |
| * @param input the InputStream with the data to deserialize |
| */ |
| public suspend fun readFrom(input: InputStream): T |
| |
| /** |
| * Marshal object to a stream. Closing the provided OutputStream is a no-op. |
| * |
| * @param t the data to write to output |
| * @output the OutputStream to serialize data to |
| */ |
| public suspend fun writeTo(t: T, output: OutputStream) |
| } |
