StorageConnection

Added in 1.1.1

Kotlin |Java

Cmn

interface StorageConnection<T : Any?> : Closeable

StorageConnection provides a way to read and write a particular type of data. StorageConnections are created from Storage objects.

Summary

Public functions
`suspend R`	`<R : Any?> readScope(block: suspend ReadScope<T>.(locked: Boolean) -> R)` Creates a scope for reading to allow storage reads, and will try to obtain a read lock.	Cmn
`suspend Unit`	`writeScope(block: suspend WriteScope<T>.() -> Unit)` Creates a write scope that guaranteed to only have one single writer, ensuring also that any reads within this scope have the most current data.	Cmn

Public properties
`InterProcessCoordinator`	`coordinator` Provides a coordinator to guarantee data consistency across multiple threads and processes.	Cmn

Extension functions
`suspend T`	`<T : Any?> StorageConnection<T>.readData()`	Cmn
`suspend Unit`	`<T : Any?> StorageConnection<T>.writeData(value: T)`	Cmn

Unit

close()

Closes the specified resource.

Cmn

Cmn

suspend fun <R : Any?> readScope(block: suspend ReadScope<T>.(locked: Boolean) -> R): R

Creates a scope for reading to allow storage reads, and will try to obtain a read lock.

Parameters
`block: suspend ReadScope<T>.(locked: Boolean) -> R`	The block of code that is performed within this scope. Block will receive `locked` parameter which is true if the try lock succeeded.

Throws
`androidx.datastore.core.IOException`	when there is an unrecoverable exception in reading.

Cmn

Added in 1.1.1

suspend fun writeScope(block: suspend WriteScope<T>.() -> Unit): Unit

Creates a write scope that guaranteed to only have one single writer, ensuring also that any reads within this scope have the most current data.

Throws
`androidx.datastore.core.IOException`	when there is an unrecoverable exception in writing.

Cmn

Added in 1.1.1

val coordinator: InterProcessCoordinator

Provides a coordinator to guarantee data consistency across multiple threads and processes.

Cmn

suspend fun <T : Any?> StorageConnection<T>.readData(): T

Cmn

suspend fun <T : Any?> StorageConnection<T>.writeData(value: T): Unit