fix: more formats and comments

Author: HatemMn

Cargo.toml

@@ -30,4 +30,4 @@ cosmian_crypto_core = { version = "10.2", default-features = false, features = [
 criterion = { version = "0.6" }
 smol-macros = { version = "0.1" }
 tokio = { version = "1.46" }
-futures = "0.3.31" # Todo: this is a temporary approach
+futures = "0.3.31"

crate/findex/Cargo.toml

@@ -21,7 +21,7 @@ test-utils = ["agnostic-lite", "criterion"]
 [dependencies]
 aes = "0.8"
 cosmian_crypto_core.workspace = true
-cosmian_sse_memories = { path = "../memories", version = "8.0.2" }
+cosmian_sse_memories = { path = "../memories", version = "8.0.2" } # Should be above 8.0.2 to have batching features.
 xts-mode = "0.5"
 futures.workspace = true
 # Optional dependencies for testing and benchmarking.

crate/findex/src/adt.rs

@@ -51,9 +51,8 @@ pub trait VectorADT: Send {
     fn read(&self) -> impl Send + Future<Output = Result<Vec<Self::Value>, Self::Error>>;
 }
 
-/// This trait  extends the functionality of the standard `IndexADT` by
-/// providing methods that operate on multiple keywords or entries
-/// simultaneously to cut network's overhead and improve performance.
+/// This trait  extends the functionality of the standard `IndexADT` by providing methods that operate
+/// on multiple keywords or entries simultaneously.
 #[cfg(feature = "batch")]
 pub trait IndexBatcher<Keyword, Value> {
     type Error: std::error::Error;

crate/findex/src/batcher_findex.rs

@@ -39,7 +39,7 @@ impl<
         }
     }
 
-    // Insert or delete are both an unbounded number of calls to `guarded_write` on
+    // Both insert and delete operations make an unbounded number of calls to `guarded_write` on
     // the memory layer.
     async fn batch_insert_or_delete<Keyword>(
         &self,
@@ -54,10 +54,8 @@ impl<
 
         for (guard_keyword, bindings) in entries {
             let memory = memory.clone();
-            // Create a temporary Findex instance using the shared batching layer
+            // Create a temporary Findex instance using the shared batching layer.
             let findex = Findex::<WORD_LENGTH, Value, EncodingError, _>::new(
-                // This (cheap) Arc clone is necessary because `decrement_capacity` is called
-                // below and needs to be able to access the Arc.
                 memory.clone(),
                 *self.encode,
                 *self.decode,
@@ -121,7 +119,6 @@ impl<
 
         for keyword in keywords {
             let memory = memory.clone();
-            // Create a temporary Findex instance using the shared batching layer.
             let findex = Findex::<WORD_LENGTH, Value, EncodingError, _>::new(
                 memory,
                 *self.encode,
@@ -132,7 +129,6 @@ impl<
             futures.push(future);
         }
 
-        // Execute all futures concurrently and collect results.
         futures::future::try_join_all(futures)
             .await
             .map_err(|e| BatchFindexError::Findex(e))

crate/findex/src/benches.rs

@@ -10,10 +10,7 @@ use cosmian_crypto_core::{Secret, reexport::rand_core::CryptoRngCore};
 use cosmian_sse_memories::{ADDRESS_LENGTH, Address, MemoryADT};
 use criterion::{BenchmarkId, Criterion};
 
-use crate::{
-    Findex, IndexADT, WORD_LENGTH, dummy_decode, dummy_encode,
-    encryption_layer::MemoryEncryptionLayer,
-};
+use crate::{Findex, IndexADT, MemoryEncryptionLayer, WORD_LENGTH, dummy_decode, dummy_encode};
 
 const MAX_VAL: usize = 1_000;
 

crate/findex/src/error.rs

@@ -1,4 +1,3 @@
-// TODO
 use std::fmt::{Debug, Display};
 
 #[cfg(feature = "batch")]

crate/findex/src/findex.rs

@@ -144,9 +144,7 @@ mod tests {
     use cosmian_sse_memories::{ADDRESS_LENGTH, Address, InMemory};
     use smol_macros::Executor;
 
-    use crate::{
-        Findex, IndexADT, dummy_decode, dummy_encode, encryption_layer::MemoryEncryptionLayer,
-    };
+    use crate::{Findex, IndexADT, MemoryEncryptionLayer, dummy_decode, dummy_encode};
 
     // Define a byte type, and use `Value` as an alias for 8-bytes values of
     // that type.

crate/findex/src/lib.rs

@@ -17,13 +17,6 @@ mod benches;
 pub use adt::IndexADT;
 #[cfg(feature = "test-utils")]
 pub use benches::*;
-
-#[cfg(feature = "batch")]
-mod batcher_findex;
-#[cfg(feature = "batch")]
-pub use adt::IndexBatcher;
-#[cfg(feature = "batch")]
-pub use batcher_findex::FindexBatcher;
 pub use encoding::{
     Decoder, Encoder,
     generic_encoding::{generic_decode, generic_encode},
@@ -37,6 +30,13 @@ pub use encryption_layer::{KEY_LENGTH, MemoryEncryptionLayer};
 pub use error::Error;
 pub use findex::{Findex, Op};
 
+#[cfg(feature = "batch")]
+mod batcher_findex;
+#[cfg(feature = "batch")]
+pub use adt::IndexBatcher;
+#[cfg(feature = "batch")]
+pub use batcher_findex::FindexBatcher;
+
 #[cfg(feature = "test-utils")]
 pub mod reexport {
     // Re-exporting the most commonly used runtime interfaces for convenience.

crate/findex/src/ovec.rs

@@ -218,8 +218,8 @@ mod tests {
     use cosmian_sse_memories::{ADDRESS_LENGTH, Address, InMemory};
 
     use crate::{
+        MemoryEncryptionLayer,
         adt::tests::{test_vector_concurrent, test_vector_sequential},
-        encryption_layer::MemoryEncryptionLayer,
         ovec::IVec,
     };