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

ReplaceFileCorruptionHandler

class ReplaceFileCorruptionHandler<T> : CorruptionHandler<T>
kotlin.Any
   ↳ androidx.datastore.handlers.ReplaceFileCorruptionHandler

A corruption handler that attempts to replace the on-disk data with data from produceNewData.

If the handler successfully replaces the data, the original exception is swallowed. If the handler encounters an exception when attempting to replace data, the new exception is added as a suppressed exception to the original exception and the original exception is thrown.

Summary

Public constructors
<init>(produceNewData: (CorruptionException) -> T)

A corruption handler that attempts to replace the on-disk data with data from produceNewData.

Public methods
suspend T

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

Public constructors

<init>

ReplaceFileCorruptionHandler(produceNewData: (CorruptionException) -> T)

A corruption handler that attempts to replace the on-disk data with data from produceNewData.

If the handler successfully replaces the data, the original exception is swallowed. If the handler encounters an exception when attempting to replace data, the new exception is added as a suppressed exception to the original exception and the original exception is thrown.

Parameters
produceNewData: (CorruptionException) -> T The provided callback returns the data to be written to disk. If the callback fails, nothing will be written to disk. Since the exception will be swallowed after writing the data, this is a good place to log the exception.

Public methods

handleCorruption

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.