1 /*
2  * Copyright 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package androidx.datastore.core
18 
19 /**
20  * Storage provides a way to create StorageConnections that allow read and write a particular type
21  * <T> of data. Storage is used to construct DataStore objects, and encapsulates all the specifics
22  * of the data format and persistence.
23  *
24  * Implementers provide the specifics of how and where the data is stored.
25  */
26 interface Storage<T> {
27     /**
28      * Creates a storage connection which allows reading and writing to the underlying storage.
29      *
30      * Should be closed after usage.
31      *
32      * @throws IOException Unrecoverable IO exception when trying to access the underlying storage.
33      */
createConnectionnull34     fun createConnection(): StorageConnection<T>
35 }
36