Struct MmapVectorSegment 

pub struct MmapVectorSegment { /* private fields */ }

Memory-mapped vector segment file (v2 NDVS format).

Exposes a &[f32] view of the vector data block and a &[u64] view of the surrogate ID block — both zero-copy slices into the mmap region.

Typically owned by a single Data Plane core, but safe to share across threads behind an [Arc]: see the Send/Sync safety note below.

Implementations

impl MmapVectorSegment

pub fn create( dir: &Path, name: &str, dim: usize, vectors: &[&[f32]], memory: &ScopedMemory, ) -> Result<Self, VectorError>

Create the segment file name inside dir (surrogates default to 0) and open it, tracked against memory.

pub fn create_with_surrogates( dir: &Path, name: &str, dim: usize, vectors: &[&[f32]], surrogate_ids: &[u64], memory: &ScopedMemory, ) -> Result<Self, VectorError>

Create the segment file name inside dir with explicit surrogate IDs and open it, tracked against memory.

pub fn create_with_policy( dir: &Path, name: &str, dim: usize, vectors: &[&[f32]], policy: VectorSegmentDropPolicy, memory: &ScopedMemory, ) -> Result<Self, VectorError>

Create the segment file name inside dir with an explicit drop policy, tracked against memory.

pub fn open(path: &Path, memory: &ScopedMemory) -> Result<Self, VectorError>

Open an existing segment file and memory-map it.

Reserves file_size bytes against the bound database, tenant, and engine budget before mapping the file. Returns VectorError::BudgetExhausted if the reservation is rejected. The reservation is released automatically when the segment is dropped (RAII via ReservationToken).

pub fn open_with_policy( path: &Path, memory: &ScopedMemory, policy: VectorSegmentDropPolicy, ) -> Result<Self, VectorError>

Open an existing segment with an explicit drop policy, tracked against memory.

pub fn madvise_state(&self) -> Option<c_int>

The madvise hint set on this segment (if any).

pub fn get_vector(&self, id: u32) -> Option<&[f32]>

Get a vector by local index. Returns a slice into the mmap’d region.

pub fn get_surrogate_id(&self, id: u32) -> Option<u64>

Get the surrogate ID for a local index (0-based row in this segment).

pub fn all_vectors_flat(&self) -> &[f32]

The full vector data block as a contiguous &[f32] of length D × N.

Suitable for SIMD distance computation over all vectors.

pub fn all_surrogate_ids(&self) -> &[u64]

The full surrogate ID block as a contiguous &[u64] of length N.

Parallel to all_vectors_flat: row i in vectors ↔ surrogate_ids[i].

pub fn prefetch(&self, id: u32)

Prefetch a vector’s page into memory via madvise(MADV_WILLNEED).

pub fn prefetch_batch(&self, ids: &[u32])

Prefetch a batch of vector IDs.

pub fn dim(&self) -> usize

pub fn count(&self) -> usize

pub fn path(&self) -> &Path

pub fn mmap_bytes(&self) -> usize

pub fn file_size(&self) -> usize

Trait Implementations

impl Debug for MmapVectorSegment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for MmapVectorSegment

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for MmapVectorSegment

impl Sync for MmapVectorSegment