Struct Geode

pub struct Geode {
    files_path: PathBuf,
    chunks_path: PathBuf,
}

Chunk-based file storage interface.

Fields

files_path: PathBuf

Path to the filesystem directory where file metadata is stored

chunks_path: PathBuf

Path to the filesystem directory where file chunks are stored

Implementations

impl Geode

pub async fn new(base_path: &PathBuf) -> Result<Self>

Instantiate a new Geode object. base_path defines the root directory where Geode will store its file metadata and chunks.

async fn read_metadata(path: &PathBuf) -> Result<Vec<Hash>>

Attempt to read chunk hashes from a given file path and return a Vec containing the hashes in order.

pub async fn garbage_collect(&self) -> Result<(HashSet<Hash>, HashSet<Hash>)>

Perform garbage collection over the filesystem hierarchy. Returns sets representing deleted files and deleted chunks, respectively.

pub async fn insert( &self, stream: impl AsyncRead + Unpin, ) -> Result<(Hash, Vec<Hash>)>

Insert a file into Geode. The function expects any kind of byte stream, which can either be another file on the filesystem, a buffer, etc. Returns a tuple of (blake3::Hash, Vec<blake3::Hash>) which represents the file name, and the file’s chunks, respectively.

pub async fn insert_file( &self, file_hash: &Hash, chunk_hashes: &[Hash], ) -> Result<()>

Create and insert file metadata into Geode given a list of hashes. Always overwrites any existing file.

pub async fn insert_chunk(&self, stream: impl AsRef<[u8]>) -> Result<Hash>

Create and insert a single chunk into Geode given a stream. Always overwrites any existing chunk. Returns the chunk hash once inserted.

pub async fn get(&self, file_hash: &Hash) -> Result<ChunkedFile>

Fetch file metadata from Geode. Returns ChunkedFile which gives a list of chunks and optionally file paths to the said chunks. Returns an error if the read failed in any way (could also be the file does not exist).

pub async fn get_chunk(&self, chunk_hash: &Hash) -> Result<PathBuf>

Fetch a single chunk from Geode. Returns a PathBuf pointing to the chunk if it is found.