shrike 0.1.1

AT Protocol library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//! Merkle Search Tree implementation for AT Protocol repositories.
//!
//! An MST is a hybrid structure combining a Merkle tree and a search tree,
//! providing both cryptographic integrity and efficient key-based lookups.
//! AT Protocol uses MSTs to store repository records with deterministic
//! ordering and content addressing.
//!
//! The Tree type provides insert, get, remove, and list operations. All
//! mutations produce a new root CID. The diff function compares two trees
//! and returns added, updated, and removed entries.
//!
//! BlockStore manages the content-addressed blocks that make up the tree.
//! Use MemBlockStore for in-memory trees or implement BlockStore for
//! persistent storage.

pub mod block_store;
pub mod diff;
pub mod height;
pub mod node;
pub mod tree;

pub use block_store::{BlockStore, MemBlockStore};
pub use diff::{Diff, diff};
pub use height::height_for_key;
pub use tree::Tree;

use thiserror::Error;

/// Errors produced by MST operations.
#[derive(Debug, Error)]
pub enum MstError {
    /// A required block was not found in the block store.
    #[error("block not found: {0}")]
    BlockNotFound(String),
    /// A node's structure or data is malformed.
    #[error("invalid node: {0}")]
    InvalidNode(String),
    /// Failed to encode or decode CBOR data for a node.
    #[error("CBOR error: {0}")]
    Cbor(String),
    /// An unexpected internal error.
    #[error("internal error: {0}")]
    Internal(String),
}