Expand description
§VOLE-Document
A persistent procedural document runtime with byte-exact reconstruction.
The governing invariants of the exact profile are:
materialize(descriptor) == original_bytes
materialize(field_root) == original_bytesParsing, semantic equivalence, canonicalization, or a successful round trip through a document writer are not substitutes for this invariant.
§Layered representation
source bytes X
-> deterministic format analysis (advisory; never destructive)
-> bounded reconstruction hypothesis
-> Document Reconstruction Algebra program + parameters + typed residuals
-> typed entropy channels / rANS entropy-seed capsules
-> canonical .voldoc descriptor
-> bounded deterministic materializer
-> X exactlyrANS is the entropy substrate beneath the representation. It is not the procedural model, and an integer state is not a magic seed: a complete decoder-entry capsule carries model, state, renormalization payload, counts, and integrity.
§Persistent procedural field (Phase 11)
From Phase 11 the persisted document is also a queryable procedural field
(feature field, on by default; see the field module): a content-addressed,
immutable procedural seed DAG, a bounded hierarchical observation index,
a typed observation API with provenance and EXPLAIN/EXPLAIN ANALYZE, and
selective late materialization. A narrow observation resolves its minimum
dependency closure (and, when warm, never opens the descriptor); the exact
original bytes always rematerialize, including after the source is deleted and
across process restarts. The exactness path (materialize) never depends on
the field, a cache, an index, or any search process.
See PROJECT_STATE.md for the mechanism ledger, FINDINGS.md for the
authoritative measured results, docs/adr/ for the decisions, and SPEC.md
for the wire format.
Re-exports§
pub use error::Error;pub use error::ErrorClass;pub use error::Result;pub use limits::Limits;
Modules§
- accounting
- Complete-cost accounting.
- adapter
- Format adapters.
- codec
- Exact codec replay (Phase 6+).
- container
- The
.voldoccontainer: header, framing, and descriptor model. - dra
- The Document Reconstruction Algebra.
- encode
- Encoding: candidate portfolio, complete-cost court, and decode-before-commit.
- entropy
- Entropy substrate: canonical models, channel descriptors, and (later) rANS.
- error
- Typed errors with stable classes and documented CLI exit codes.
- field
- The persistent procedural document field (Phase 11).
- integrity
- Integrity primitives.
- limits
- Centralized resource bounds.
- materialize
- Deterministic materialization.
- store
- Content-addressed object store (Phase 9).
Constants§
- EXACTNESS_
PROFILE_ EXACT_ BYTES - The exactness profile mandated for the archival path.
- SOURCE_
FORMAT_ OPAQUE - Identifier for the opaque source-format class.
- SOURCE_
FORMAT_ PDF - Identifier for the PDF source-format class.