Struct SpatialIndexManager 

pub struct SpatialIndexManager { /* private fields */ }

Manages per-collection R-tree spatial indexes.

Each collection that has geometry fields gets its own R-tree. The field name is stored alongside so we know which document field to extract geometry from.

Implementations

impl SpatialIndexManager

pub fn new(memory: ScopedMemory) -> Self

pub fn doc_id_for_entry(&self, entry_id: u64) -> Option<&str>

Resolve an R-tree entry ID to its document ID within a collection.

pub fn index_document( &mut self, collection: &str, field: &str, doc_id: &str, geometry: &Geometry, )

Index a geometry from a document. If the document already has an entry, it is removed first (upsert semantics).

pub fn remove_document(&mut self, collection: &str, field: &str, doc_id: &str)

Remove a document’s geometry from the index.

pub fn truncate_collection(&mut self, collection: &str) -> Vec<(String, String)>

Remove every entry of every R-tree collection owns. Each tree stays registered under its (collection, field) key, so the next checkpoint writes it out empty instead of leaving a stale blob behind. Returns the (field, doc_id) of every entry removed.

pub fn search( &self, collection: &str, field: &str, query: &BoundingBox, ) -> Vec<&RTreeEntry>

Range search: find all document entry IDs whose bbox intersects the query.

pub fn nearest( &self, collection: &str, field: &str, lng: f64, lat: f64, k: usize, ) -> Vec<NnResult>

Nearest-neighbor search.

pub fn is_empty(&self) -> bool

Number of indexed entries across all collections. Whether no spatial indices exist.

pub fn total_entries(&self) -> usize

pub fn collection_count(&self) -> usize

Number of indexed collections.

pub fn checkpoint_all(&self) -> Vec<(String, String, Vec<u8>)>

Checkpoint all R-trees to bytes for persistence.

Returns a vec of (collection, field, rtree_bytes).

pub fn checkpoint_data( &self, ) -> (Vec<(String, String, Vec<u8>)>, HashMap<(String, String), u64>, u64)

Return the data needed by the checkpoint module to persist full state.

Returns (rtree_checkpoints, doc_to_entry, next_id).

pub fn load_checkpoint( &mut self, checkpoints: &[(String, String, Vec<u8>)], doc_to_entry: HashMap<(String, String), u64>, next_id: u64, )

Load a fully-restored checkpoint.

Replaces the current in-memory state with the provided R-tree checkpoints and the exact doc_id → entry_id mapping that was serialised at flush time.

pub fn restore_all( checkpoints: &[(String, String, Vec<u8>)], memory: ScopedMemory, ) -> Self

Restore R-trees from raw checkpoint bytes only (no doc_to_entry).

Used as a fallback when no docmap is available (e.g. legacy checkpoints written before this field was introduced). After restoration, upserts and deletes of already-indexed docs may not evict stale entries; a full rebuild from documents is the reliable recovery path in that case.

pub fn rebuild_from_documents( &mut self, collection: &str, field: &str, documents: &[(String, Geometry)], )

Rebuild spatial index from a collection of documents.

Scans all documents, extracts geometry from the specified field, and builds the R-tree.