Do not expose StoreReader::fork_cache and ::cache_key in the public A…

…PI if only Searcher::docs_async uses them.
quickwit-oss · Dec 11, 2023 · 59695d1 · 59695d1
1 parent 472432d
commit 59695d1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/src/store/mod.rs b/src/store/mod.rs
@@ -37,8 +37,8 @@ mod reader;
 mod writer;
 pub use self::compressors::{Compressor, ZstdCompressor};
 pub use self::decompressors::Decompressor;
-pub(crate) use self::reader::DOCSTORE_CACHE_CAPACITY;
-pub use self::reader::{CacheKey, CacheStats, StoreReader};
+pub(crate) use self::reader::{CacheKey, DOCSTORE_CACHE_CAPACITY};
+pub use self::reader::{CacheStats, StoreReader};
 pub use self::writer::StoreWriter;
 mod store_compressor;
 

diff --git a/src/store/reader.rs b/src/store/reader.rs
@@ -92,7 +92,7 @@ impl BlockCache {
 
 /// Opaque cache key which indicates which documents are cached together.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
-pub struct CacheKey(usize);
+pub(crate) struct CacheKey(usize);
 
 #[derive(Debug, Default)]
 /// CacheStats for the `StoreReader`.
@@ -148,7 +148,7 @@ impl StoreReader {
     }
 
     /// Clones the given store reader with an independent block cache of the given size.
-    pub fn fork_cache(&self, cache_num_blocks: usize) -> Self {
+    pub(crate) fn fork_cache(&self, cache_num_blocks: usize) -> Self {
         Self {
             decompressor: self.decompressor,
             data: self.data.clone(),
@@ -180,7 +180,7 @@ impl StoreReader {
     ///
     /// Note that looking up the cache key of a document
     /// will not yet pull anything into the block cache.
-    pub fn cache_key(&self, doc_id: DocId) -> crate::Result<CacheKey> {
+    pub(crate) fn cache_key(&self, doc_id: DocId) -> crate::Result<CacheKey> {
         let checkpoint = self.block_checkpoint(doc_id)?;
         Ok(CacheKey(checkpoint.byte_range.start))
     }