Struct RTree 

pub struct RTree { /* private fields */ }

R*-tree spatial index.

Supports insert, delete, range search (bbox intersection), and incremental nearest-neighbor queries. Array-backed nodes for cache friendliness.

References:

• Beckmann et al., “The R*-tree” (1990)
• Hjaltason & Samet, “Distance Browsing in Spatial Databases” (1999)

Implementations

impl RTree

pub fn checkpoint_to_bytes( &self, kek: Option<&WalEncryptionKey>, ) -> Result<Vec<u8>, RTreeCheckpointError>

Serialize the R-tree to bytes for checkpointing.

When kek is Some, the inner rkyv payload is wrapped in an AES-256-GCM encrypted SEGV envelope. When None, the raw rkyv bytes (with RKSPT\0 inner magic) are returned (existing plaintext format).

pub fn from_checkpoint( bytes: &[u8], kek: Option<&WalEncryptionKey>, ) -> Result<Self, RTreeCheckpointError>

Restore an R-tree from checkpoint bytes.

kek controls the expected framing:

• None → file must be plaintext (starting with RKSPT\0). If it starts with SEGV, returns Err(MissingKek).
• Some(key) → encryption is required. If the file starts with SEGV, it is decrypted. If plaintext, returns Err(KekRequired).

impl RTree

pub fn bulk_load(entries: Vec<RTreeEntry>) -> Self

Bulk load entries using Sort-Tile-Recursive packing.

More efficient than repeated single inserts for large datasets. Produces better packing (less overlap between nodes).

pub fn bulk_load_with_governor( entries: Vec<RTreeEntry>, governor: Arc<MemoryGovernor>, ) -> Self

Bulk load with an optional governor for budget accounting.

The governor is stored on the returned tree and used for subsequent batch operations (full-scan, checkpoint serialization).

impl RTree

pub fn delete(&mut self, id: EntryId) -> bool

Delete an entry by ID. Returns true if found and removed.

impl RTree

pub fn insert(&mut self, entry: RTreeEntry)

Insert an entry into the R-tree.

impl RTree

pub fn new() -> Self

pub fn set_governor(&mut self, governor: Arc<MemoryGovernor>)

Inject a MemoryGovernor to enforce per-engine memory budgets on large batch allocations (bulk load, full-scan serialization, range search result collection). When not set, allocations proceed without budget enforcement — correct for NodeDB-Lite and WASM builds.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

Range search: return all entries whose bbox intersects the query bbox.

pub fn search_owned(&self, query: &BoundingBox) -> Vec<RTreeEntry>

Range search returning owned entries.

pub fn nearest(&self, query_lng: f64, query_lat: f64, k: usize) -> Vec<NnResult>

Nearest-neighbor search using incremental distance ordering.

pub fn entries(&self) -> Vec<&RTreeEntry>

Get all entries (for persistence serialization).

Trait Implementations

impl Default for RTree

fn default() -> Self

Returns the “default value” for a type.