Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent contains the contracts and implementations of background agents: Ingester, GC, Scrub, Snapshot, Sync, Ejector.
|
Package agent contains the contracts and implementations of background agents: Ingester, GC, Scrub, Snapshot, Sync, Ejector. |
|
Package core is the Scrinium Storage Engine (layer L2).
|
Package core is the Scrinium Storage Engine (layer L2). |
|
internal/descriptor
Package descriptor reads and writes the Store descriptor file (store.json).
|
Package descriptor reads and writes the Store descriptor file (store.json). |
|
internal/kdf
Package kdf is the Scrinium key-derivation primitive.
|
Package kdf is the Scrinium key-derivation primitive. |
|
internal/keywrap
Package keywrap wraps and unwraps the data-encryption key (DEK) with the key-encryption key (KEK) using AES-256-GCM.
|
Package keywrap wraps and unwraps the data-encryption key (DEK) with the key-encryption key (KEK) using AES-256-GCM. |
|
internal/recoverykit
Package recoverykit encodes and decodes the Scrinium Recovery Kit per §10.3.
|
Package recoverykit encodes and decodes the Scrinium Recovery Kit per §10.3. |
|
Package curator is the orchestrator at layer L3.
|
Package curator is the orchestrator at layer L3. |
|
bundler
Package bundler implements the decorator that transparently packs small blobs into .pack volumes through HostStorage.
|
Package bundler implements the decorator that transparently packs small blobs into .pack volumes through HostStorage. |
|
chunker
Package chunker implements the decorator that transparently CDC-slices large streams into anonymous chunks and creates a TOC manifest.
|
Package chunker implements the decorator that transparently CDC-slices large streams into anonymous chunks and creates a TOC manifest. |
|
host
Package host implements HostStorage — the transit buffer on a fast local disk used by Curator for deferred writes to slow Target Stores, manifest caching with ManifestStorage: Local/Replicated, and buffering before bundler packing.
|
Package host implements HostStorage — the transit buffer on a fast local disk used by Curator for deferred writes to slow Target Stores, manifest caching with ManifestStorage: Local/Replicated, and buffering before bundler packing. |
|
Package domain holds the value types of the Scrinium engine — artifacts, manifests, physical addresses, configuration enums.
|
Package domain holds the value types of the Scrinium engine — artifacts, manifests, physical addresses, configuration enums. |
|
Package driver declares the Scrinium transport layer (L1): stateless adapters for accessing a Location of arbitrary nature (local filesystem, S3, network shares).
|
Package driver declares the Scrinium transport layer (L1): stateless adapters for accessing a Location of arbitrary nature (local filesystem, S3, network shares). |
|
faulty
Package faulty wraps another driver.Driver and injects configurable faults: errors and latency on a per-method basis.
|
Package faulty wraps another driver.Driver and injects configurable faults: errors and latency on a per-method basis. |
|
localfs
Package localfs implements driver.Driver on top of a local POSIX filesystem.
|
Package localfs implements driver.Driver on top of a local POSIX filesystem. |
|
s3
Package s3 will provide an S3-compatible Driver implementation.
|
Package s3 will provide an S3-compatible Driver implementation. |
|
Package errs holds every sentinel error of the Scrinium engine.
|
Package errs holds every sentinel error of the Scrinium engine. |
|
Package event provides shared event types and the event bus implementation used by all Scrinium layers.
|
Package event provides shared event types and the event bus implementation used by all Scrinium layers. |
|
Package index contains implementations of core.StoreIndex and curator.MultistoreIndex.
|
Package index contains implementations of core.StoreIndex and curator.MultistoreIndex. |
|
postgres
Package postgres will provide a PostgreSQL-backed StoreIndex implementation.
|
Package postgres will provide a PostgreSQL-backed StoreIndex implementation. |
|
sqlite
Package sqlite is the reference implementation of core.StoreIndex backed by SQLite.
|
Package sqlite is the reference implementation of core.StoreIndex backed by SQLite. |
|
internal
|
|
|
blobpath
Package blobpath maps a blob's logical name to its driver-side path according to the Store's PathTopology.
|
Package blobpath maps a blob's logical name to its driver-side path according to the Store's PathTopology. |
|
manifestcodec
Package manifestcodec serialises and deserialises manifest files according to docs/2.
|
Package manifestcodec serialises and deserialises manifest files according to docs/2. |
|
manifestcrypto
Package manifestcrypto provides AES-256-GCM authenticated encryption for manifest bodies in MetadataOnly and Envelope modes per docs/2.
|
Package manifestcrypto provides AES-256-GCM authenticated encryption for manifest bodies in MetadataOnly and Envelope modes per docs/2. |
|
testutil/storefx
Package storefx supplies Store fixtures for tests.
|
Package storefx supplies Store fixtures for tests. |
|
timefmt
Package timefmt holds the on-disk timestamp format shared by index/sqlite and internal/manifestcodec.
|
Package timefmt holds the on-disk timestamp format shared by index/sqlite and internal/manifestcodec. |
|
uriresolve
Package uriresolve resolves the local-path forms shared by the file:// and sqlite:// URI schemes.
|
Package uriresolve resolves the local-path forms shared by the file:// and sqlite:// URI schemes. |
|
Package maintenance contains the implementations of one-shot administrative agents: RebuildIndexAgent, MigrateIndexAgent, VerificationAgent, MoveStoreAgent.
|
Package maintenance contains the implementations of one-shot administrative agents: RebuildIndexAgent, MigrateIndexAgent, VerificationAgent, MoveStoreAgent. |
|
Package plugin contains plugin implementations for layer L2: concrete hashers, compressors, crypto plugins, and key resolvers.
|
Package plugin contains plugin implementations for layer L2: concrete hashers, compressors, crypto plugins, and key resolvers. |
|
compress/zstd
Package zstd provides a Scrinium TransformerFactory for the zstd compression algorithm via github.com/klauspost/compress/zstd.
|
Package zstd provides a Scrinium TransformerFactory for the zstd compression algorithm via github.com/klauspost/compress/zstd. |
|
crypto/aesgcm
Package aesgcm provides a Scrinium TransformerFactory for the AES-256-GCM AEAD cipher via the Go standard library.
|
Package aesgcm provides a Scrinium TransformerFactory for the AES-256-GCM AEAD cipher via the Go standard library. |
|
Package projection builds virtual human-friendly views over the store without copying data.
|
Package projection builds virtual human-friendly views over the store without copying data. |
|
fsindex
Package fsindex is an index extension that persists the fsmeta payload of every artifact whose Manifest.Metadata uses the filesystem schema.
|
Package fsindex is an index extension that persists the fsmeta payload of every artifact whose Manifest.Metadata uses the filesystem schema. |
|
fsmeta
Package fsmeta is the standard filesystem schema for Manifest.Metadata.
|
Package fsmeta is the standard filesystem schema for Manifest.Metadata. |
|
vfs
Package vfs is the read/write virtual filesystem layer over a projection.View.
|
Package vfs is the read/write virtual filesystem layer over a projection.View. |
Click to show internal directories.
Click to hide internal directories.