spi/me.ahoo.wow.spi.snapshot/SnapshotSaveOutcome

SnapshotSaveOutcome

How the save of one snapshot of a SnapshotStore.saveAll ended: Written, Refused by the version guard (the store holds the same or a later version, or one of a higher state revision, which the save then marked stale), or Failed alone, the others of the batch unaffected. A failure of the whole call is thrown instead.

Inheritors

Written

Refused

Failed

Types

Companion

@InternalWowApi

object Companion

Failed

class Failed @InternalWowApi constructor(val cause: Throwable) : SnapshotSaveOutcome

The store failed to save this snapshot alone (cause): a value it refuses, say. Whether it was written is not known; saving it again is safe, the save being version-guarded.

Refused

data object Refused : SnapshotSaveOutcome

The version guard refused the snapshot, which is not an error.

Written

data object Written : SnapshotSaveOutcome

The snapshot replaced the stored one, or there was none.

Properties

written

abstract val written: Boolean

Whether the snapshot was written: what SnapshotStore.save returns for it.