Module data_store 

Portable state access for Traverse capabilities.

General operations are governed by spec 032-universal-data-access; the local-file adapter durability boundary is governed by spec 518-durable-local-datastore. Retention prune and verified backup/restore are governed by spec 083-datastore-retention-backup.

Structs

AblyHistoryBatch

Ordered history batch returned by an Ably edge.

AblyHostedSyncTransport

Optional Ably-shaped hosted adapter. Core callers depend only on HostedSyncTransport; Ably channel names stay inside AblyRealtimeEdge.

BackupManifest

BackupRecordIndexEntry

DataStoreCoordinator

Host-facing, fenced write coordinator governed by Spec 093.

DataStoreError

EncryptedSyncOperation

Encrypted synchronization operation. The adapter never interprets plaintext (FR-006).

HostedSyncCredential

Short-lived, least-privilege credential issued by the application backend (FR-003).

HostedSyncError

Sanitized transport error with secret-free details.

HostedSyncLineageEvidence

Declared/observed lineage evidence for one relayed operation (FR-012).

HostedSyncObservation

Redacted observability record (FR-011).

HostedSyncPublishReceipt

Publish acknowledgement with opaque cursor advancement.

InMemoryAblyEdge

Deterministic Ably edge double used by the shared conformance suite.

InMemoryHostedSyncTransport

Deterministic in-memory hosted transport used as the replacement-boundary fixture.

InMemoryKeyProvider

In-memory provider for tests and host wiring.

KeyProviderError

A key-provider failure that never includes key material or provider internals.

LamportClock

LocalFileDataStore

LocalFileDataStoreMaintenance

MaintenanceError

MaintenanceEvidence

Secret-free maintenance evidence (FR-009).

MergeDecision

MigrationError

MigrationReport

Safe evidence returned to the owning host; it never contains paths, keys, or values.

RemoteKeyValueDataStore

Provider-neutral remote key-value DataStore adapter (spec 094), conformant to the S3-compatible profile (spec 095) when B implements conditional writes/deletes over an S3-compatible backend.

RemoteObject

One host-fetched remote object: its stored bytes and current version.

RemoteOperationEvidence

Safe evidence for one remote operation (spec 094 FR-009): operation, outcome, classification, consistency mode, retry count, and stable failure code only. Never a key, value, credential, endpoint, or tenant.

RemoteVersionToken

Opaque, provider-issued concurrency token (e.g. an S3 ETag). Traverse never interprets its contents or treats it as an integrity digest.

RetentionPolicy

Host retention knobs for prune (FR-002).

RuntimeDataStore

StateRecord

SyncReport

SyncScopeId

Opaque, backend-derived synchronization scope (FR-004). Not a capability ID.

Enums

AblyEdgeError

Errors from the Ably edge translation layer.

ConflictResolutionRule

DataStoreCoordinatorError

DataStoreErrorCode

HostedSyncConnectionState

Typed connection / synchronization state (FR-005, FR-010).

HostedSyncDegradedReason

Why synchronization entered a degraded state.

HostedSyncErrorCode

Stable machine-readable failure codes (FR-005, FR-012).

HostedSyncReplayResult

Outcome of a cursor-based replay request (FR-008).

KeyProviderErrorCode

Stable, secret-free key-provider failure codes.

LocalDataClassification

Classification recorded with each locally durable record.

MaintenanceErrorCode

Stable maintenance failure codes (FR-010).

MigrationErrorCode

Stable, secret-free failure codes for an explicit host-owned v1-to-v2 migration.

RemoteBackendFailure

Stable, secret-free host-backend failure categories (spec 094 FR-007 / spec 095 FR-008, minus the outcomes that are not backend failures).

RemoteWriteOutcome

Outcome of a conditional write or delete against the host backend.

Traits

AblyRealtimeEdge

Injectable Ably edge so the optional adapter stays replaceable and testable.

DataStore

DataStoreMaintenance

Separate maintenance port for the same root and exclusive lock (FR-001).

DataStoreMigration

Host-explicit format-migration port. Generic runtime and CLI paths never call it.

HostedSyncTransport

Provider-neutral hosted synchronization transport port (FR-001).

KeyProvider

Host-owned source of AES-256 keys.

RemoteDataStoreBackend

Host-provided, provider-specific transport. The host owns endpoint selection, authentication, tenant mapping, and retry policy; Traverse only validates envelope/integrity semantics and projects safe outcomes.

Functions

run_hosted_sync_conformance

Runs the Spec 087 hosted-transport conformance suite against any adapter.

validate_state_write

Validates a capability state write against the contract-declared state schema.