Add docs

Author: G8XSU

src/lib.rs

@@ -9,6 +9,7 @@
 
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
+#![deny(missing_docs)]
 
 /// Implements a thin-client ([`client::VssClient`]) to access a hosted instance of Versioned Storage Service (VSS).
 pub mod client;

src/util/mod.rs

@@ -1 +1,4 @@
+/// Contains [StorableBuilder] helper utility.
+///
+/// [StorableBuilder]: storable_builder::StorableBuilder
 pub mod storable_builder;

src/util/storable_builder.rs

@@ -7,13 +7,23 @@ use std::borrow::Borrow;
 use std::io;
 use std::io::{Error, ErrorKind};
 
+/// [`StorableBuilder`] is a helper utility to build and deconstruct [`Storable`] objects.
+/// It provides client-side `Encrypt-then-MAC` using ChaCha20-Poly1305.
 pub struct StorableBuilder {
 	data_encryption_key: [u8; 32],
 }
 
 const CHACHA20_CIPHER_NAME: &'static str = "ChaCha20Poly1305";
 
 impl StorableBuilder {
+
+	/// Creates a [`Storable`] that can be serialized and stored as `value` in [PutObjectRequest].
+	///
+	/// Uses ChaCha20 for encrypting the `input` and Poly1305 for generating mac/tag.
+	///
+	/// Refer to docs on [`Storable`] for more information.
+	///
+	/// [PutObjectRequest]: crate::types::PutObjectRequest
 	pub fn build(&self, input: Vec<u8>, version: i64) -> Storable {
 		let mut rng = ThreadRng::default();
 		let mut nonce = [0u8; 12];
@@ -34,6 +44,10 @@ impl StorableBuilder {
 		}
 	}
 
+	/// Deconstructs the provided [`Storable`] and returns constituent decrypted data and it's
+	/// corresponding version as stored at the time of [PutObjectRequest].
+	///
+	/// [PutObjectRequest]: crate::types::PutObjectRequest
 	pub fn deconstruct(&self, mut storable: Storable) -> io::Result<(Vec<u8>, i64)> {
 		let encryption_metadata = storable.encryption_metadata.unwrap();
 		let mut cipher = ChaCha20Poly1305::new(&self.data_encryption_key, &encryption_metadata.nonce, &[]);