chore: internal API visibility adjustments (#53)

Author: eeeebbbbrrrr

.github/workflows/test.yml

@@ -76,7 +76,9 @@ jobs:
             profile: minimal
             override: true
 
-    - uses: taiki-e/install-action@nextest
+    - uses: taiki-e/install-action@v2
+      with:
+        tool: 'nextest'
     - uses: Swatinem/rust-cache@v2
 
     - name: Run tests

.gitignore

@@ -17,3 +17,4 @@ variable
 
 # for `sample record -p`
 profile.json
+profile.json.gz

src/postings/loaded_postings.rs

@@ -15,10 +15,10 @@ use crate::DocId;
 /// terms.
 /// E.g. 100_000 terms would need 184MB due to SegmentPostings.
 pub struct LoadedPostings {
-    doc_ids: Box<[DocId]>,
-    position_offsets: Box<[u32]>,
-    positions: Box<[u32]>,
-    cursor: usize,
+    pub doc_ids: Box<[DocId]>,
+    pub position_offsets: Box<[u32]>,
+    pub positions: Box<[u32]>,
+    pub cursor: usize,
 }
 
 impl LoadedPostings {

src/postings/mod.rs

@@ -21,7 +21,7 @@ mod serializer;
 pub(crate) mod skip;
 mod term_info;
 
-pub(crate) use loaded_postings::LoadedPostings;
+pub use loaded_postings::LoadedPostings;
 pub(crate) use stacker::compute_table_memory_size;
 
 pub use self::block_segment_postings::BlockSegmentPostings;

src/query/boolean_query/boolean_query.rs

@@ -1,6 +1,7 @@
 use super::boolean_weight::BooleanWeight;
 use crate::query::{EnableScoring, Occur, Query, SumCombiner, TermQuery, Weight};
-use crate::schema::{IndexRecordOption, Term};
+use crate::schema::{Field, IndexRecordOption, Term};
+use crate::SegmentReader;
 
 /// The boolean query returns a set of documents
 /// that matches the Boolean combination of constituent subqueries.
@@ -168,9 +169,14 @@ impl Query for BooleanQuery {
         )))
     }
 
-    fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool)) {
+    fn query_terms(
+        &self,
+        field: Field,
+        segment_reader: &SegmentReader,
+        visitor: &mut dyn FnMut(&Term, bool),
+    ) {
         for (_occur, subquery) in &self.subqueries {
-            subquery.query_terms(visitor);
+            subquery.query_terms(field, segment_reader, visitor);
         }
     }
 }

src/query/boost_query.rs

@@ -3,6 +3,7 @@ use std::fmt;
 use crate::docset::COLLECT_BLOCK_BUFFER_LEN;
 use crate::fastfield::AliveBitSet;
 use crate::query::{EnableScoring, Explanation, Query, Scorer, Weight};
+use crate::schema::Field;
 use crate::{DocId, DocSet, Score, SegmentReader, Term};
 
 /// `BoostQuery` is a wrapper over a query used to boost its score.
@@ -48,8 +49,13 @@ impl Query for BoostQuery {
         Ok(boosted_weight)
     }
 
-    fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool)) {
-        self.query.query_terms(visitor)
+    fn query_terms(
+        &self,
+        field: Field,
+        segment_reader: &SegmentReader,
+        visitor: &mut dyn FnMut(&Term, bool),
+    ) {
+        self.query.query_terms(field, segment_reader, visitor)
     }
 }
 

src/query/const_score_query.rs

@@ -2,6 +2,7 @@ use std::fmt;
 
 use crate::docset::COLLECT_BLOCK_BUFFER_LEN;
 use crate::query::{EnableScoring, Explanation, Query, Scorer, Weight};
+use crate::schema::Field;
 use crate::{DocId, DocSet, Score, SegmentReader, TantivyError, Term};
 
 /// `ConstScoreQuery` is a wrapper over a query to provide a constant score.
@@ -46,8 +47,13 @@ impl Query for ConstScoreQuery {
         })
     }
 
-    fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool)) {
-        self.query.query_terms(visitor);
+    fn query_terms(
+        &self,
+        field: Field,
+        segment_reader: &SegmentReader,
+        visitor: &mut dyn FnMut(&Term, bool),
+    ) {
+        self.query.query_terms(field, segment_reader, visitor);
     }
 }
 

src/query/disjunction_max_query.rs

@@ -1,5 +1,6 @@
 use crate::query::{BooleanWeight, DisjunctionMaxCombiner, EnableScoring, Occur, Query, Weight};
-use crate::{Score, Term};
+use crate::schema::Field;
+use crate::{Score, SegmentReader, Term};
 
 /// The disjunction max query returns documents matching one or more wrapped queries,
 /// called query clauses or clauses.
@@ -104,9 +105,14 @@ impl Query for DisjunctionMaxQuery {
         )))
     }
 
-    fn query_terms<'a>(&'a self, visitor: &mut dyn FnMut(&'a Term, bool)) {
+    fn query_terms(
+        &self,
+        field: Field,
+        segment_reader: &SegmentReader,
+        visitor: &mut dyn FnMut(&Term, bool),
+    ) {
         for disjunct in &self.disjuncts {
-            disjunct.query_terms(visitor);
+            disjunct.query_terms(field, segment_reader, visitor);
         }
     }
 }

src/query/explanation.rs

@@ -5,7 +5,7 @@ use serde::Serialize;
 
 use crate::{DocId, Score, TantivyError};
 
-pub(crate) fn does_not_match(doc: DocId) -> TantivyError {
+pub fn does_not_match(doc: DocId) -> TantivyError {
     TantivyError::InvalidArgument(format!("Document #({doc}) does not match"))
 }
 

src/query/fuzzy_query.rs

@@ -230,7 +230,7 @@ mod test {
         let get_json_path_term = |query: &str| -> crate::Result<Term> {
             let query = query_parser.parse_query(query)?;
             let mut terms = Vec::new();
-            query.query_terms(&mut |term, _| {
+            query.query_terms(attributes, searcher.segment_reader(0), &mut |term, _| {
                 terms.push(term.clone());
             });