Skip to main content

Crate hyphae_engine

Crate hyphae_engine 

Source
Expand description

Embeddable Hyphae facade over durable storage, structured query, and exact provider-neutral retrieval.

Re-exports§

pub use proof::MAX_RESULT_PROOF_BYTES;
pub use proof::ProofAnchor;
pub use proof::ProofError;
pub use proof::ProvenOperation;
pub use proof::ProvenResult;
pub use proof::RESULT_PROOF_FORMAT_VERSION;
pub use proof::ResultProof;
pub use proof::ResultProofArtifact;
pub use proof::VerificationLimits;
pub use proof::VerificationReport;
pub use proof::read_result_proof;
pub use proof::verify_result_proof;
pub use proof::write_result_proof;
pub use retrieval_proof::EXACT_RETRIEVAL_SEMANTICS_VERSION;
pub use retrieval_proof::ExactRetrievalProof;
pub use retrieval_proof::ExactRetrievalProofArtifact;
pub use retrieval_proof::ExactRetrievalVerificationReport;
pub use retrieval_proof::HYBRID_RETRIEVAL_SEMANTICS_VERSION;
pub use retrieval_proof::HybridRetrievalProof;
pub use retrieval_proof::HybridRetrievalProofArtifact;
pub use retrieval_proof::HybridRetrievalVerificationReport;
pub use retrieval_proof::LEXICAL_RETRIEVAL_SEMANTICS_VERSION;
pub use retrieval_proof::LexicalRetrievalProof;
pub use retrieval_proof::LexicalRetrievalProofArtifact;
pub use retrieval_proof::LexicalRetrievalVerificationReport;
pub use retrieval_proof::MAX_RETRIEVAL_PROOF_BYTES;
pub use retrieval_proof::RETRIEVAL_PROOF_FORMAT_VERSION;
pub use retrieval_proof::RetrievalProofAnchor;
pub use retrieval_proof::RetrievalProofError;
pub use retrieval_proof::RetrievalVerificationLimits;
pub use retrieval_proof::read_exact_retrieval_proof;
pub use retrieval_proof::read_hybrid_retrieval_proof;
pub use retrieval_proof::read_lexical_retrieval_proof;
pub use retrieval_proof::verify_exact_retrieval_proof;
pub use retrieval_proof::verify_hybrid_retrieval_proof;
pub use retrieval_proof::verify_lexical_retrieval_proof;
pub use retrieval_proof::write_exact_retrieval_proof;
pub use retrieval_proof::write_hybrid_retrieval_proof;
pub use retrieval_proof::write_lexical_retrieval_proof;

Modules§

proof
Canonical snapshot-witness result proofs and offline verification.
retrieval_proof
Canonical durable-retrieval proofs and complete offline verification.

Structs§

HyphaeEngine
Embeddable autonomous Hyphae engine.
MaintenanceLimits
Finite policy for one snapshot or online compaction operation.
OpenedEngine
Newly opened embeddable engine and durable recovery evidence.
RecoveryLimits
Finite policy for one complete open/recovery operation.
StorageLimits
Complete finite policy for opening and maintaining one data directory.

Enums§

BoundedEngineQueryError
Failure from the additive engine query entry points that enforce an aggregate durable byte budget.
DocumentError
Failure while encoding or verifying one canonical structured document.
EngineError
Failure while operating the embeddable Hyphae facade.
StorageLimitError
Failure of a finite storage recovery or maintenance policy.

Constants§

MAX_DOCUMENT_BYTES
Maximum canonical document payload bytes.
MAX_DOCUMENT_DEPTH
Maximum nested array/object depth, with the root at depth zero.
MAX_DOCUMENT_NODES
Maximum values decoded from one document.

Functions§

decode_document
Verifies and decodes one canonical binary document.
encode_document
Encodes one structured value into a checksummed canonical binary document.