SnapshotApplyResult

sealed class SnapshotApplyResult

The result of a applying a mutable snapshot. Success indicates that the snapshot was successfully applied and is not visible as the global state of the state object (or visible in the parent snapshot for a nested snapshot). Failure indicates one or more state objects were modified by both this snapshot and in the global (or parent) snapshot.

Types

Failure
Link copied to clipboard
common
class Failure(snapshot: Snapshot) : SnapshotApplyResult
Success
Link copied to clipboard
common
object Success : SnapshotApplyResult

Functions

check
Link copied to clipboard
common
abstract fun check()
Check the result of an apply.
equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
toString
Link copied to clipboard
common
open fun toString(): String

Properties

succeeded
Link copied to clipboard
common
abstract val succeeded: Boolean
True if the result is Success.

Inheritors

SnapshotApplyResult
Link copied to clipboard
SnapshotApplyResult
Link copied to clipboard