Struct MmapSidecarIndex 

pub struct MmapSidecarIndex<Id>
where
    Id: Clone + Eq + Debug,
{ /* private fields */ }

A memory-mapped sidecar index with zero-copy access to compressed payloads.

The file is memory-mapped via memmap2::Mmap. The FibScorer is reconstructed from the profile and gram table in the file (owned data). Each entry’s compressed FibCodeV1 bytes remain as &[u8] slices into the mmap — they are decoded on demand during search.

The _mmap field keeps the mapping alive for the lifetime of this struct.

Implementations

impl<Id> MmapSidecarIndex<Id>

where Id: Clone + Eq + Debug + DeserializeOwned,

pub fn open(path: &Path) -> Result<Self>

Memory-map a sidecar file and provide zero-copy access to compressed payloads.

The FibScorer is reconstructed from the profile (by rebuilding the quantizer). Each entry’s compact bytes stay as zero-copy &[u8] slices into the mmap and are decoded on demand during search.

Safety

This uses Mmap::map() which requires the file to be a valid mmap-able file. The file must not be modified while the mmap is alive.

Errors

Returns FibQuantError::CorruptPayload for malformed files, or IO errors wrapped in CorruptPayload.

pub fn scorer(&self) -> &FibScorer

Return a reference to the scorer.

pub fn profile(&self) -> &FibQuantProfileV1

Return a reference to the profile.

pub fn len(&self) -> usize

Number of entries.

pub fn is_empty(&self) -> bool

Whether the index is empty.

pub fn search( &self, query: &[f32], top_k: usize, oversample: usize, ) -> Result<Vec<ScoredCandidate<Id>>>

where Id: Clone,

Approximate search returning sorted candidates.

Decodes each entry’s compressed bytes on demand from the mmap slices, scores them against the query using the Gram table estimator, and returns the top top_k * oversample candidates.

See FibSidecarIndex::search for full semantics.