nitrite_spatial 0.1.0

Spatial indexing support for Nitrite database using R-Tree
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

use nitrite::{common::{NitriteModule, NitritePlugin, PluginRegistrar}, errors::NitriteResult, index::NitriteIndexer};

use crate::SpatialIndexer;

/// Nitrite module for loading the spatial indexer.
///
/// Use this module to enable spatial indexing in your Nitrite database.
///
/// ## Example
///
/// ```rust,ignore
/// use nitrite::nitrite_builder::NitriteBuilder;
/// use nitrite_spatial::SpatialModule;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let db = Nitrite::builder()
///     .load_module(SpatialModule)
///     .open_or_create(None, None)?;
/// # Ok(())
/// # }
/// ```
pub struct SpatialModule;

impl Default for SpatialModule {
    fn default() -> Self {
        Self
    }
}

impl NitriteModule for SpatialModule {
    fn plugins(&self) -> NitriteResult<Vec<NitritePlugin>> {
        Ok(vec![NitritePlugin::new(SpatialIndexer::new())])
    }

    fn load(&self, plugin_registrar: &PluginRegistrar) -> NitriteResult<()> {
        plugin_registrar.register_indexer_plugin(NitriteIndexer::new(SpatialIndexer::new()))
    }
}