Skip to main content

hyphae_engine/
lib.rs

1// SPDX-License-Identifier: Apache-2.0
2
3//! Embeddable Hyphae facade over durable storage, structured query, and exact
4//! provider-neutral retrieval.
5
6mod facade;
7pub mod proof;
8pub mod retrieval_proof;
9
10pub use facade::{BoundedEngineQueryError, EngineError, HyphaeEngine, OpenedEngine};
11pub use hyphae_query::{
12    DocumentError, MAX_DOCUMENT_BYTES, MAX_DOCUMENT_DEPTH, MAX_DOCUMENT_NODES, decode_document,
13    encode_document,
14};
15pub use hyphae_storage::{MaintenanceLimits, RecoveryLimits, StorageLimitError, StorageLimits};
16pub use proof::{
17    MAX_RESULT_PROOF_BYTES, ProofAnchor, ProofError, ProvenOperation, ProvenResult,
18    RESULT_PROOF_FORMAT_VERSION, ResultProof, ResultProofArtifact, VerificationLimits,
19    VerificationReport, read_result_proof, verify_result_proof, write_result_proof,
20};
21pub use retrieval_proof::{
22    EXACT_RETRIEVAL_SEMANTICS_VERSION, ExactRetrievalProof, ExactRetrievalProofArtifact,
23    ExactRetrievalVerificationReport, HYBRID_RETRIEVAL_SEMANTICS_VERSION, HybridRetrievalProof,
24    HybridRetrievalProofArtifact, HybridRetrievalVerificationReport,
25    LEXICAL_RETRIEVAL_SEMANTICS_VERSION, LexicalRetrievalProof, LexicalRetrievalProofArtifact,
26    LexicalRetrievalVerificationReport, MAX_RETRIEVAL_PROOF_BYTES, RETRIEVAL_PROOF_FORMAT_VERSION,
27    RetrievalProofAnchor, RetrievalProofError, RetrievalVerificationLimits,
28    read_exact_retrieval_proof, read_hybrid_retrieval_proof, read_lexical_retrieval_proof,
29    verify_exact_retrieval_proof, verify_hybrid_retrieval_proof, verify_lexical_retrieval_proof,
30    write_exact_retrieval_proof, write_hybrid_retrieval_proof, write_lexical_retrieval_proof,
31};