src/backup.rs - improve doc

This commit is contained in:
Dietmar Maurer
2019-02-12 13:27:11 +01:00
parent 93d5d77952
commit d78345bcfc
2 changed files with 15 additions and 1 deletions

View File

@ -1,4 +1,15 @@
//! This mudule implements the proxmox backup chunked data storage
//! This module implements the proxmox backup chunked data storage
//!
//! A chunk is simply defined as binary blob. We store them inside a
//! `ChunkStore`, addressed by the SHA256 digest of the binary
//! blob. This technology is also known as content-addressable
//! storage.
//!
//! We store larger files by splitting them into chunks. The resulting
//! SHA256 digest list is stored as separate index file. The
//! `DynamicIndex*` format is able to deal with dynamic chunk sizes,
//! whereas the `FixedIndex*` format is an optimization to store a
//! list of equal sized chunks.
pub mod chunker;
pub mod chunk_store;