Skip to main content

Searcher

Struct Searcher 

Source
pub struct Searcher<D: Directory + 'static> { /* private fields */ }
Expand description

Searcher - provides search over loaded segments

For wasm/read-only use, create via Searcher::open(). For native use with Index, this is created via IndexReader.

Implementations§

Source§

impl<D: Directory + 'static> Searcher<D>

Source

pub async fn open( directory: Arc<D>, schema: Arc<Schema>, segment_ids: &[String], term_cache_blocks: usize, ) -> Result<Self>

Create a Searcher directly from segment IDs

This is a simpler initialization path that doesn’t require SegmentManager. Use this for read-only access to pre-built indexes.

Source

pub fn schema(&self) -> &Schema

Get the schema

Source

pub fn segment_readers(&self) -> &[Arc<SegmentReader>]

Get segment readers

Source

pub fn default_fields(&self) -> &[Field]

Get default fields for search

Source

pub fn tokenizers(&self) -> &TokenizerRegistry

Get tokenizer registry

Source

pub fn trained_centroids(&self) -> &FxHashMap<u32, Arc<CoarseCentroids>>

Get trained centroids

Source

pub fn global_stats(&self) -> &Arc<LazyGlobalStats>

Get lazy global statistics for cross-segment IDF computation

Source

pub fn num_docs(&self) -> u32

Get total document count across all segments

Source

pub fn segment_map(&self) -> &FxHashMap<u128, usize>

Get O(1) segment_id → index map (used by reranker)

Source

pub fn num_segments(&self) -> usize

Get number of segments

Source

pub async fn doc(&self, doc_id: u32) -> Result<Option<Document>>

Get a document by global doc_id (binary search on cumulative offsets)

Source

pub async fn search( &self, query: &dyn Query, limit: usize, ) -> Result<Vec<SearchResult>>

Search across all segments and return aggregated results

Source

pub async fn search_with_count( &self, query: &dyn Query, limit: usize, ) -> Result<(Vec<SearchResult>, u32)>

Search across all segments and return (results, total_seen) total_seen is the number of documents that were scored across all segments

Source

pub async fn search_with_offset( &self, query: &dyn Query, limit: usize, offset: usize, ) -> Result<Vec<SearchResult>>

Search with offset for pagination

Source

pub async fn search_with_offset_and_count( &self, query: &dyn Query, limit: usize, offset: usize, ) -> Result<(Vec<SearchResult>, u32)>

Search with offset and return (results, total_seen)

Source

pub async fn search_with_positions( &self, query: &dyn Query, limit: usize, ) -> Result<(Vec<SearchResult>, u32)>

Search with positions (ordinal tracking) and return (results, total_seen)

Use this when you need per-ordinal scores for multi-valued fields.

Source

pub async fn search_and_rerank( &self, query: &dyn Query, l1_limit: usize, final_limit: usize, config: &RerankerConfig, ) -> Result<(Vec<SearchResult>, u32)>

Two-stage search: L1 retrieval + L2 dense vector reranking

Runs the query to get l1_limit candidates, then reranks by exact dense vector distance and returns the top final_limit results.

Source

pub async fn query( &self, query_str: &str, limit: usize, ) -> Result<SearchResponse>

Parse query string and search (convenience method)

Source

pub async fn query_offset( &self, query_str: &str, limit: usize, offset: usize, ) -> Result<SearchResponse>

Parse query string and search with offset (convenience method)

Source

pub fn query_parser(&self) -> QueryLanguageParser

Get query parser for this searcher

Source

pub async fn get_document( &self, address: &DocAddress, ) -> Result<Option<Document>>

Get a document by address (segment_id + global doc_id)

The doc_id in the address is a global doc_id (with doc_id_offset applied). This method converts it back to a segment-local doc_id for the store lookup.

Source

pub async fn get_document_with_fields( &self, address: &DocAddress, fields: Option<&FxHashSet<u32>>, ) -> Result<Option<Document>>

Get a document by address, hydrating only the specified field IDs.

If fields is None, all fields are hydrated (including dense vectors). If fields is Some(set), only dense vector fields in the set are read from flat storage — skipping expensive mmap reads for unrequested vectors.

Auto Trait Implementations§

§

impl<D> Freeze for Searcher<D>

§

impl<D> !RefUnwindSafe for Searcher<D>

§

impl<D> Send for Searcher<D>

§

impl<D> Sync for Searcher<D>

§

impl<D> Unpin for Searcher<D>

§

impl<D> !UnwindSafe for Searcher<D>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V