Google is committed to advancing racial equity for Black communities. See how.

CorruptionHandler

interface CorruptionHandler<T>
androidx.datastore.CorruptionHandler

CorruptionHandlers allow recovery from corruption that prevents reading data from the file (as indicated by a CorruptionException).

Summary

Public methods
abstract suspend T

This function will be called by DataStore when it encounters corruption.

Public methods

handleCorruption

abstract suspend fun handleCorruption(ex: CorruptionException): T

This function will be called by DataStore when it encounters corruption. If the implementation of this function throws an exception, it will be propagated to the original call to DataStore. Otherwise, the returned data will be written to disk.

This function should not interact with any DataStore API - doing so can result in a deadlock.

Parameters
ex: CorruptionException is the exception encountered when attempting to deserialize data from disk.
Return
The value that DataStore should attempt to write to disk.