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::{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 proof::{
16    MAX_RESULT_PROOF_BYTES, ProofAnchor, ProofError, ProvenOperation, ProvenResult,
17    RESULT_PROOF_FORMAT_VERSION, ResultProof, ResultProofArtifact, VerificationLimits,
18    VerificationReport, read_result_proof, verify_result_proof, write_result_proof,
19};
20pub use retrieval_proof::{
21    EXACT_RETRIEVAL_SEMANTICS_VERSION, ExactRetrievalProof, ExactRetrievalProofArtifact,
22    ExactRetrievalVerificationReport, HYBRID_RETRIEVAL_SEMANTICS_VERSION, HybridRetrievalProof,
23    HybridRetrievalProofArtifact, HybridRetrievalVerificationReport,
24    LEXICAL_RETRIEVAL_SEMANTICS_VERSION, LexicalRetrievalProof, LexicalRetrievalProofArtifact,
25    LexicalRetrievalVerificationReport, MAX_RETRIEVAL_PROOF_BYTES, RETRIEVAL_PROOF_FORMAT_VERSION,
26    RetrievalProofAnchor, RetrievalProofError, RetrievalVerificationLimits,
27    read_exact_retrieval_proof, read_hybrid_retrieval_proof, read_lexical_retrieval_proof,
28    verify_exact_retrieval_proof, verify_hybrid_retrieval_proof, verify_lexical_retrieval_proof,
29    write_exact_retrieval_proof, write_hybrid_retrieval_proof, write_lexical_retrieval_proof,
30};