Struct VectorIndexMemoryUsage 

pub struct VectorIndexMemoryUsage {

    pub indexed_rows: u64,
    pub row_bitmap_bytes: usize,
    pub row_bitmap_serialized_bytes: usize,
    pub hnsw_index_bytes: usize,
    pub hnsw_referenced_vector_bytes: usize,
    pub hnsw_entries: usize,
    pub hnsw_live_entries: usize,
    pub hnsw_deleted_entries: usize,
    pub hnsw_link_count: usize,
    pub hnsw_level_zero_link_count: usize,
    pub hnsw_upper_layer_link_count: usize,
    pub hnsw_max_layer_count: usize,
    pub hnsw_max_links_per_layer: usize,
    pub hnsw_average_links_per_entry_basis_points: usize,
    pub ivf_index_bytes: usize,
    pub ivf_referenced_vector_bytes: usize,
    pub ivf_entries: usize,
    pub ivf_live_entries: usize,
    pub ivf_deleted_entries: usize,
    pub ivf_centroids: usize,
    pub ivf_list_count: usize,
    pub ivf_non_empty_list_count: usize,
    pub ivf_max_list_len: usize,
    pub ivf_average_list_len_basis_points: usize,
    pub ivf_assigned_entries: usize,
    pub ivf_pending_retrain_entries: usize,
    pub turbo_quant_index_bytes: usize,
    pub turbo_quant_referenced_vector_bytes: usize,
    pub turbo_quant_entries: usize,
    pub turbo_quant_live_entries: usize,
    pub turbo_quant_deleted_entries: usize,
    pub turbo_quant_code_bytes: usize,
    pub turbo_quant_codebook_bytes: usize,
    pub turbo_quant_calibration_bytes: usize,
    pub estimated_index_bytes: usize,
    pub estimated_reachable_bytes: usize,
}

Estimated resident memory and cardinality details for one vector index.

This is intentionally an estimate rather than allocator-exact accounting. estimated_index_bytes counts index-owned structures and excludes primary graph vector component allocations that ANN indexes may share through Arc handles. estimated_reachable_bytes adds the component bytes referenced by derived entries and centroids as an upper-bound view; deleted ANN entries can retain old component storage until the derived index is rebuilt.

Fields

indexed_rows: u64

Number of live rows currently admitted to the index.

row_bitmap_bytes: usize

Estimated heap bytes owned by the row bitmap.

row_bitmap_serialized_bytes: usize

Roaring serialized size for the row bitmap.

hnsw_index_bytes: usize

Estimated heap bytes owned by the HNSW derived index, excluding vector components.

hnsw_referenced_vector_bytes: usize

Component bytes reachable through HNSW vector handles.

hnsw_entries: usize

Total HNSW entries, including stale deleted row versions.

hnsw_live_entries: usize

Live HNSW entries reachable from row membership.

hnsw_deleted_entries: usize

Stale HNSW entries retained for traversability after update/delete.

hnsw_link_count: usize

Stored directed HNSW links across all layers.

hnsw_level_zero_link_count: usize

Stored directed HNSW links in the level-0 layer.

hnsw_upper_layer_link_count: usize

Stored directed HNSW links above the level-0 layer.

hnsw_max_layer_count: usize

Maximum HNSW layer count attached to any indexed entry.

hnsw_max_links_per_layer: usize

Maximum directed HNSW links stored in a single entry layer.

hnsw_average_links_per_entry_basis_points: usize

Average directed HNSW links per entry, scaled by 10,000.

ivf_index_bytes: usize

Estimated heap bytes owned by the IVF derived index, excluding vector components.

ivf_referenced_vector_bytes: usize

Component bytes reachable through IVF vector handles.

ivf_entries: usize

Total IVF entries, including stale deleted row versions.

ivf_live_entries: usize

Live IVF entries reachable from row membership.

ivf_deleted_entries: usize

Stale IVF entries retained until the derived index is rebuilt.

ivf_centroids: usize

Number of trained IVF centroids.

ivf_list_count: usize

Number of IVF inverted lists.

ivf_non_empty_list_count: usize

Number of IVF inverted lists with at least one assigned live entry.

ivf_max_list_len: usize

Maximum assigned live entries in one IVF inverted list.

ivf_average_list_len_basis_points: usize

Average assigned live entries per IVF inverted list, scaled by 10,000.

ivf_assigned_entries: usize

Non-stale IVF entries assigned to inverted lists.

ivf_pending_retrain_entries: usize

Live IVF entries whose current vector was inserted or replaced after centroid training.

turbo_quant_index_bytes: usize

Estimated heap bytes owned by the TurboQuant derived index, excluding vector components.

turbo_quant_referenced_vector_bytes: usize

Component bytes reachable through TurboQuant-owned full-vector handles.

turbo_quant_entries: usize

Total TurboQuant compressed entries.

turbo_quant_live_entries: usize

Live TurboQuant row entries.

turbo_quant_deleted_entries: usize

Stale TurboQuant entries retained by the derived index.

TurboQuant compacts deletes and replacements immediately, so this should normally remain zero.

turbo_quant_code_bytes: usize

Packed TurboQuant coordinate-code bytes.

turbo_quant_codebook_bytes: usize

TurboQuant scalar codebook bytes.

turbo_quant_calibration_bytes: usize

TurboQuant per-dimension calibration bytes.

estimated_index_bytes: usize

Estimated bytes for index-owned structures, excluding referenced vector components.

estimated_reachable_bytes: usize

Estimated upper-bound bytes reachable from the index including ANN vector components.

Implementations

impl VectorIndexMemoryUsage

pub fn ivf_pending_retrain_basis_points(&self) -> usize

Return pending IVF retrain entries divided by live IVF entries, scaled by 10,000.

pub fn ivf_rebuild_recommended(&self) -> bool

Return true when the IVF index should be rebuilt by maintenance soon.

The recommendation is deliberately diagnostic only: reads never rebuild indexes, and callers still decide when to run selene.rebuild_vector_indexes. Deleted IVF entries are not part of this first trigger because delete maintenance already unlinks them from inverted lists; existing reclaimed counters expose that memory-only pressure separately.

Trait Implementations

impl Clone for VectorIndexMemoryUsage

fn clone(&self) -> VectorIndexMemoryUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VectorIndexMemoryUsage

impl Debug for VectorIndexMemoryUsage

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

Formats the value using the given formatter.

impl Default for VectorIndexMemoryUsage

fn default() -> VectorIndexMemoryUsage

Returns the “default value” for a type.

impl Eq for VectorIndexMemoryUsage

impl PartialEq for VectorIndexMemoryUsage

fn eq(&self, other: &VectorIndexMemoryUsage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VectorIndexMemoryUsage