Enum VectorIndex 

pub enum VectorIndex {
    BinaryIvf(Arc<MmapAnnIndex>),
    Tq {
        index: Arc<MmapAnnIndex>,
        codec: Arc<TqCodec>,
    },
    IvfTq {
        index: Arc<MmapAnnIndex>,
        codec: Arc<TqCodec>,
    },
    ScannAh(Arc<MmapAnnIndex>),
    ScannBinary(Arc<MmapAnnIndex>),
}

Production ANN payloads for float IVF-PQ and packed-binary IVF.

Raw flat vectors are stored separately in LazyFlatVectorData and accessed via mmap for reranking and merge. This enum only holds ANN indexes.

Both variants use the same validated mmap-backed run format. Corpus-sized columns stay in the file mapping; only the compact run directory is parsed.

Variants

BinaryIvf(Arc<MmapAnnIndex>)

Binary IVF (Hamming) payload.

Tq

TurboQuant flat payload with its derived (training-free) codec.

Fields

index: Arc<MmapAnnIndex>

codec: Arc<TqCodec>

IvfTq

IVF-TQ payload: trained coarse router, TurboQuant residual leaves.

Fields

index: Arc<MmapAnnIndex>

codec: Arc<TqCodec>

ScannAh(Arc<MmapAnnIndex>)

ScaNN float asymmetric-hash leaves. Routing/codebook data is global.

ScannBinary(Arc<MmapAnnIndex>)

ScaNN exact packed-binary Hamming leaves. Routing data is global.

Implementations

impl VectorIndex

pub fn estimated_heap_bytes(&self) -> usize

Estimate heap retained by this vector index. Corpus-sized ANN columns remain file-backed and are not included.

Trait Implementations

impl Clone for VectorIndex

fn clone(&self) -> VectorIndex

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.