Struct HashTree 

pub struct HashTree<S: Store> { /* private fields */ }

HashTree - unified create, read, and edit merkle tree operations

Implementations

impl<S: Store> HashTree<S>

pub fn new(config: HashTreeConfig<S>) -> Self

pub fn is_encrypted(&self) -> bool

Check if encryption is enabled

pub async fn put(&self, data: &[u8]) -> Result<Cid, HashTreeError>

Store content, returns Cid (hash + optional key) Encrypts by default when encryption feature is enabled

pub async fn get(&self, cid: &Cid) -> Result<Option<Vec<u8>>, HashTreeError>

Get content by Cid (handles decryption automatically)

pub async fn put_stream<R: AsyncRead + Unpin>( &self, reader: R, ) -> Result<Cid, HashTreeError>

Store content from an async reader (streaming put)

Reads data in chunks and builds a merkle tree incrementally. Useful for large files or streaming data sources.

pub fn get_stream( &self, cid: &Cid, ) -> Pin<Box<dyn Stream<Item = Result<Vec<u8>, HashTreeError>> + Send + '_>>

Read content as a stream of chunks by Cid (handles decryption automatically)

Returns an async stream that yields chunks as they are read. Useful for large files or when you want to process data incrementally.

pub async fn put_blob(&self, data: &[u8]) -> Result<Hash, HashTreeError>

Store a blob directly (small data, no encryption) Returns the content hash

pub async fn put_file( &self, data: &[u8], ) -> Result<PutFileResult, HashTreeError>

Store a file, chunking if necessary Returns root hash and total size

pub async fn put_directory( &self, entries: Vec<DirEntry>, ) -> Result<Cid, HashTreeError>

Build a directory from entries Returns Cid with key if encrypted

pub async fn put_tree_node( &self, links: Vec<Link>, ) -> Result<Hash, HashTreeError>

Create a tree node with custom links

pub async fn get_blob( &self, hash: &Hash, ) -> Result<Option<Vec<u8>>, HashTreeError>

Get raw data by hash

pub async fn get_tree_node( &self, hash: &Hash, ) -> Result<Option<TreeNode>, HashTreeError>

Get and decode a tree node (unencrypted)

pub async fn get_node( &self, cid: &Cid, ) -> Result<Option<TreeNode>, HashTreeError>

Get and decode a tree node using Cid (with decryption if key present)

pub async fn is_tree(&self, hash: &Hash) -> Result<bool, HashTreeError>

Check if hash points to a tree node (no decryption)

pub async fn is_dir(&self, cid: &Cid) -> Result<bool, HashTreeError>

Check if Cid points to a directory (with decryption)

pub async fn is_directory(&self, hash: &Hash) -> Result<bool, HashTreeError>

Check if hash points to a directory (tree with named links, no decryption)

pub async fn read_file( &self, hash: &Hash, ) -> Result<Option<Vec<u8>>, HashTreeError>

Read a complete file (reassemble chunks if needed)

pub fn read_file_stream( &self, hash: Hash, ) -> Pin<Box<dyn Stream<Item = Result<Vec<u8>, HashTreeError>> + Send + '_>>

Read a file as stream of chunks Returns an async stream that yields chunks as they are read

pub async fn read_file_chunks( &self, hash: &Hash, ) -> Result<Vec<Vec<u8>>, HashTreeError>

Read file chunks as Vec (non-streaming version)

pub async fn list(&self, cid: &Cid) -> Result<Vec<TreeEntry>, HashTreeError>

List directory entries (Cid-based, supports encrypted directories)

pub async fn list_directory( &self, cid: &Cid, ) -> Result<Vec<TreeEntry>, HashTreeError>

List directory entries using Cid (with decryption if key present)

pub async fn resolve( &self, cid: &Cid, path: &str, ) -> Result<Option<Cid>, HashTreeError>

Resolve a path within a tree (returns Cid with key if encrypted)

pub async fn resolve_path( &self, cid: &Cid, path: &str, ) -> Result<Option<Cid>, HashTreeError>

Resolve a path within a tree using Cid (with decryption if key present)

pub async fn get_size(&self, hash: &Hash) -> Result<u64, HashTreeError>

Get total size of a tree

pub async fn walk( &self, cid: &Cid, path: &str, ) -> Result<Vec<WalkEntry>, HashTreeError>

Walk entire tree depth-first (returns Vec)

pub fn walk_stream( &self, cid: Cid, initial_path: String, ) -> Pin<Box<dyn Stream<Item = Result<WalkEntry, HashTreeError>> + Send + '_>>

Walk tree as stream

pub async fn set_entry( &self, root: &Cid, path: &[&str], name: &str, entry_cid: &Cid, link_type: LinkType, ) -> Result<Cid, HashTreeError>

Add or update an entry in a directory Returns new root Cid (immutable operation)

pub async fn remove_entry( &self, root: &Cid, path: &[&str], name: &str, ) -> Result<Cid, HashTreeError>

Remove an entry from a directory Returns new root Cid

pub async fn rename_entry( &self, root: &Cid, path: &[&str], old_name: &str, new_name: &str, ) -> Result<Cid, HashTreeError>

Rename an entry in a directory Returns new root Cid

pub async fn move_entry( &self, root: &Cid, source_path: &[&str], name: &str, target_path: &[&str], ) -> Result<Cid, HashTreeError>

Move an entry to a different directory Returns new root Cid

pub fn get_store(&self) -> Arc<S>

Get the underlying store

pub fn chunk_size(&self) -> usize

Get chunk size configuration

pub fn max_links(&self) -> usize

Get max links configuration