Skip to main content

Crate hyphae_storage

Crate hyphae_storage 

Source
Expand description

Durable log, recovery, snapshot, and materialized-index implementation.

Structs§

BackupInfo
Verified metadata for one portable backup directory.
CommitReceipt
Durable identity of a committed transaction.
CompactionReport
Evidence for one successfully committed compaction generation.
DataDirectory
An exclusively owned Hyphae data directory.
DurableLog
Append-only transaction log with synchronous commit durability.
KvEntry
One binary KV entry in canonical key order.
KvPage
One bounded ordered KV scan page.
MaintenanceLimits
Finite policy for one snapshot or online compaction operation.
OpenedLog
A newly opened writer together with its recovery evidence.
OpenedStorage
A newly opened storage engine and its recovery evidence.
RecoveredTransaction
A committed transaction reconstructed from the verified log.
RecoveryLimits
Finite policy for one complete open/recovery operation.
RecoveryReport
Evidence produced while opening and validating a segment.
RestoreInfo
Evidence that a backup was fully verified before destination activation.
SnapshotContents
Fully verified logical snapshot contents for offline operations.
SnapshotEntry
One verified logical KV entry loaded from a canonical snapshot.
SnapshotInfo
Verified metadata for one logical snapshot.
SnapshotReadLimits
Resource limits for loading a verified logical snapshot as an offline witness.
SnapshotReceipts
Receipts retained by an offline migration witness without changing the public snapshot payload shape.
SnapshotVectorEntry
One verified durable vector loaded from a canonical snapshot.
StorageEngine
Single-writer durable KV storage composed from the log and rebuildable redb index.
StorageLimits
Complete finite policy for opening and maintaining one data directory.
StorageRecoveryReport
Recovery evidence returned when the complete embedded storage layer opens.
VectorEntry
One durable vector entry materialized from authoritative logical state.

Enums§

AppendOutcome
Result of an idempotent append request.
BackupError
Failure while creating, verifying, or restoring a portable backup.
CompactionOutcome
Result of an online compaction request.
DataDirectoryError
Failure while opening or initializing a Hyphae data directory.
LogError
Failure while opening, validating, or appending to a durable log.
ManifestError
Failure while loading or atomically creating a storage manifest.
MaterializedIndexError
Failure while opening, verifying, or updating the rebuildable redb index.
Mutation
A deterministic mutation persisted inside one transaction operation frame.
MutationError
Failure while validating or decoding a persisted mutation.
ScanPageError
Failure while scanning one page under an explicit aggregate byte budget.
SnapshotError
Failure while creating or verifying a logical snapshot.
StorageError
Failure while opening or operating the durable embedded storage engine.
StorageLimitError
Failure of a finite storage recovery or maintenance policy.
VectorEntriesError
Failure while reading a vector space under an explicit end-to-end retrieval deadline.

Constants§

MAX_KEY_BYTES
Maximum encoded key length accepted by the embedded KV layer.
MAX_SCAN_PAGE_ENTRIES
Maximum KV entries returned by one ordered storage scan page.

Functions§

load_snapshot
Loads every logical KV entry from a verified snapshot under explicit resource limits.
load_snapshot_for_migration
Loads a migration witness with durable source receipts.
load_snapshot_with_timeout
Loads a verified snapshot under explicit resource limits and a cooperative end-to-end timeout.
open_verified_snapshot_with_limits
Opens one snapshot, verifies that exact file handle under explicit limits, rewinds it, and returns the still-open verified handle for safe streaming.
restore_backup
Restores a verified backup to a new data directory.
storage_limit_from_io
Recovers a typed finite-policy failure carried through an existing I/O error variant.
verify_backup
Verifies a backup layout, bounded manifest, and complete snapshot.
verify_snapshot
Streams and verifies a snapshot without opening a Hyphae data directory.
verify_snapshot_with_limits
Streams and verifies a snapshot under explicit resource limits and one cooperative end-to-end timeout.