refactor: rename with_buffer_threshold to with_buffer_pool_size (#729)

Signed-off-by: MrCroxx <[email protected]>

Author: MrCroxx

examples/hybrid_full.rs

@@ -48,7 +48,7 @@ async fn main() -> Result<()> {
         .with_recover_concurrency(8)
         .with_flushers(2)
         .with_reclaimers(2)
-        .with_buffer_threshold(256 * 1024 * 1024)
+        .with_buffer_pool_size(256 * 1024 * 1024)
         .with_clean_region_threshold(4)
         .with_eviction_pickers(vec![Box::<FifoPicker>::default()])
         .with_admission_picker(Arc::new(RateLimitPicker::new(100 * 1024 * 1024)))

foyer-storage/src/store.rs

@@ -357,8 +357,7 @@ where
     recover_concurrency: usize,
     flushers: usize,
     reclaimers: usize,
-    // FIXME(MrCroxx): rename the field and builder fn.
-    buffer_threshold: usize,
+    buffer_pool_size: usize,
     clean_region_threshold: Option<usize>,
     eviction_pickers: Vec<Box<dyn EvictionPicker>>,
     admission_picker: Arc<dyn AdmissionPicker<Key = K>>,
@@ -387,7 +386,7 @@ where
             recover_concurrency: 8,
             flushers: 1,
             reclaimers: 1,
-            buffer_threshold: 16 * 1024 * 1024, // 16 MiB
+            buffer_pool_size: 16 * 1024 * 1024, // 16 MiB
             clean_region_threshold: None,
             eviction_pickers: vec![Box::new(InvalidRatioPicker::new(0.8)), Box::<FifoPicker>::default()],
             admission_picker: Arc::<AdmitAllPicker<K>>::default(),
@@ -469,15 +468,32 @@ where
         self
     }
 
+    // FIXME(MrCroxx): remove it after 0.12
     /// Set the total flush buffer threshold.
     ///
     /// Each flusher shares a volume at `threshold / flushers`.
     ///
     /// If the buffer of the flush queue exceeds the threshold, the further entries will be ignored.
     ///
     /// Default: 16 MiB.
+    #[deprecated(
+        since = "0.11.4",
+        note = "The function will be renamed to \"with_buffer_pool_size()\", use it instead."
+    )]
     pub fn with_buffer_threshold(mut self, threshold: usize) -> Self {
-        self.buffer_threshold = threshold;
+        self.buffer_pool_size = threshold;
+        self
+    }
+
+    /// Set the total flush buffer pool size.
+    ///
+    /// Each flusher shares a volume at `threshold / flushers`.
+    ///
+    /// If the buffer of the flush queue exceeds the threshold, the further entries will be ignored.
+    ///
+    /// Default: 16 MiB.
+    pub fn with_buffer_pool_size(mut self, buffer_pool_size: usize) -> Self {
+        self.buffer_pool_size = buffer_pool_size;
         self
     }
 
@@ -659,7 +675,7 @@ where
                                     eviction_pickers: self.eviction_pickers,
                                     reinsertion_picker: self.reinsertion_picker,
                                     tombstone_log_config: self.tombstone_log_config,
-                                    buffer_threshold: self.buffer_threshold,
+                                    buffer_threshold: self.buffer_pool_size,
                                     statistics: statistics.clone(),
                                     write_runtime_handle,
                                     read_runtime_handle,
@@ -702,7 +718,7 @@ where
                                         eviction_pickers: self.eviction_pickers,
                                         reinsertion_picker: self.reinsertion_picker,
                                         tombstone_log_config: self.tombstone_log_config,
-                                        buffer_threshold: self.buffer_threshold,
+                                        buffer_threshold: self.buffer_pool_size,
                                         statistics: statistics.clone(),
                                         write_runtime_handle,
                                         read_runtime_handle,

foyer/src/hybrid/builder.rs

@@ -299,15 +299,37 @@ where
         }
     }
 
+    // FIXME(MrCroxx): remove it after 0.12
     /// Set the total flush buffer threshold.
     ///
     /// Each flusher shares a volume at `threshold / flushers`.
     ///
     /// If the buffer of the flush queue exceeds the threshold, the further entries will be ignored.
     ///
     /// Default: 16 MiB.
+    #[deprecated(
+        since = "0.11.4",
+        note = "The function will be renamed to \"with_buffer_pool_size()\", use it instead."
+    )]
     pub fn with_buffer_threshold(self, threshold: usize) -> Self {
-        let builder = self.builder.with_buffer_threshold(threshold);
+        let builder = self.builder.with_buffer_pool_size(threshold);
+        Self {
+            name: self.name,
+            tracing_config: self.tracing_config,
+            memory: self.memory,
+            builder,
+        }
+    }
+
+    /// Set the total flush buffer pool size.
+    ///
+    /// Each flusher shares a volume at `threshold / flushers`.
+    ///
+    /// If the buffer of the flush queue exceeds the threshold, the further entries will be ignored.
+    ///
+    /// Default: 16 MiB.
+    pub fn with_buffer_pool_size(self, buffer_pool_size: usize) -> Self {
+        let builder = self.builder.with_buffer_pool_size(buffer_pool_size);
         Self {
             name: self.name,
             tracing_config: self.tracing_config,