Module hnsw_rs::hnswio

This module provides io dump/ reload of computed graph via the structure Hnswio.
This structure stores references to data points if memory map is used.

A dump is constituted of 2 files. One file stores just the graph (or topology) with id of points.
The other file stores the ids and vector in point and can be reloaded via a mmap scheme. The graph file is suffixed by “hnsw.graph” the other is suffixed by “hnsw.data”

Examples of dump and reload of structure Hnsw is given in the tests (see test_dump_reload, reload_with_mmap)

Structs

• Description
  structure describing main parameters for hnsnw data and written at the beginning of a dump file.
• DumpInit
• HnswIo
  a structure to provide simplified methods for reloading a previous dump.
• ReloadOptions
  Describe options accessible for reload

Enums

• DumpMode

Functions

• load_description
  This method is internally used by Hnswio.
  It is make pub as it can be used to retrieve the description of a dump. It takes as input the graph part of the dump.