Struct IndexMeta 

pub struct IndexMeta {

    pub version: String,
    pub backend_name: String,
    pub embedding_model: String,
    pub dimensions: usize,
    pub backend_kwargs: HashMap<String, Value>,
    pub embedding_mode: String,
    pub passage_sources: Vec<PassageSource>,
    pub embedding_options: HashMap<String, Value>,
    pub is_compact: Option<bool>,
    pub is_pruned: Option<bool>,
    pub total_passages: Option<usize>,
    pub built_from_precomputed_embeddings: Option<bool>,
    pub embeddings_source: Option<String>,
}

Represents the metadata stored in <name>.meta.json for a LEANN index.

Fields

version: String

backend_name: String

embedding_model: String

dimensions: usize

backend_kwargs: HashMap<String, Value>

embedding_mode: String

passage_sources: Vec<PassageSource>

embedding_options: HashMap<String, Value>

is_compact: Option<bool>

Whether the HNSW index uses compact CSR storage.

is_pruned: Option<bool>

Whether embeddings have been pruned (for recompute mode).

total_passages: Option<usize>

Total passages in the index (updated on append).

built_from_precomputed_embeddings: Option<bool>

Set if built from pre-computed embeddings.

embeddings_source: Option<String>

Implementations

impl IndexMeta

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

Load metadata from a .meta.json file.

pub fn save(&self, path: &Path) -> Result<()>

Save metadata to a .meta.json file.

pub fn distance_metric(&self) -> DistanceMetric

Get the distance metric from backend kwargs.

pub fn requires_recompute(&self) -> bool

Whether this index requires embedding recomputation at search time.

Trait Implementations

impl Clone for IndexMeta

fn clone(&self) -> IndexMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexMeta

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexMeta

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexMeta

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.