soil-optimistic-update/soil.plant.compose.optimistic

Package-level declarations

Types

Link copied to clipboard
typealias OptimisticCompletionHandle = (cause: Throwable?) -> Unit

Function type for handling completion of optimistic updates.

Link copied to clipboard
@Immutable
data class OptimisticObject<T, D>

Data class representing an optimistic state with methods to apply optimistic updates.

Link copied to clipboard
typealias OptimisticUpdate<T, D> = (currentState: T, optimisticValue: D) -> T

Function type for updating state with optimistic values.

Link copied to clipboard
@Stable
interface OptimisticUpdatePolicy

Interface defining a policy for handling errors in optimistic updates.

Functions

Link copied to clipboard
@Composable
inline fun <T> rememberOptimistic(state: T, policy: OptimisticUpdatePolicy = OptimisticUpdatePolicy): OptimisticObject<T, T>

Creates and remembers an optimistic state object where the state and optimistic value are of the same type.

@Composable
fun <T, D> rememberOptimistic(state: T, policy: OptimisticUpdatePolicy = OptimisticUpdatePolicy, updateFn: OptimisticUpdate<T, D>): OptimisticObject<T, D>

Creates and remembers an optimistic state object that can track optimistic updates.