diff options
Diffstat (limited to 'rola-bucket/src/lib.rs')
| -rw-r--r-- | rola-bucket/src/lib.rs | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/rola-bucket/src/lib.rs b/rola-bucket/src/lib.rs index 8b13789..c45452c 100644 --- a/rola-bucket/src/lib.rs +++ b/rola-bucket/src/lib.rs @@ -1 +1,16 @@ +//! Rorolala Bucket +//! +//! # Introduction +//! +//! `Bucket` is the central repository in **Rola** for storing files. It stores: +//! - **Delta Fragment**: Stores incremental data of a file, friendly to uncompressed sequential large files; the actual content can be computed via an index. +//! - **Full Storage**: Stores a complete file, data can be retrieved directly via an index. +//! - **Compressed Storage**: Stores a compressed complete file, data can be retrieved directly via an index. +//! - **Limited Storage**: Stores a limited number of recent versions according to rules (maximum size, maximum number of versions); only the **existing** data can be retrieved directly via an index. +//! +//! # Interface Boundary +//! +//! This module does **not** implement any **specific transport method**; it only implements the workflow for file storage and retrieval. +mod protocol; +pub use protocol::*; |