geoverse 0.0.2

A simple library for caching reverse geocoding results
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# 🌍 Geoverse

A simple, fast reverse geocode cache library.

## Features

- **In-memory cache** — fast, zero setup
- **Disk persistence** — survives process restarts with a file-based backend

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
geoverse = "0.0.1"
```

## Quick Start

### Just in-memory cache

```rust
use geoverse::{DequeStorage, GeoCache, GeoCacheConfigBuilder};

fn main() {
  let config = GeoCacheConfigBuilder::default().build();
  let mut geo_cache = GeoCache::<DequeStorage>::new(config);

  geo_cache
    .insert(
      (48.1645819, 17.1847104, "sk"),
      "Bratislava, Slovakia".to_string(),
    )
    .expect("failed to insert address");

  let address = geo_cache
    .get((48.1645819, 17.1847104, "sk"))
    .expect("error while loading address")
    .expect("address not found");

  println!("{address}");
}
```

### Disk persistence

```rust
use geoverse::{DequeStorage, GeoCache, GeoCacheConfigBuilder, StorageFlushStrategy};

fn main() {
  let config = GeoCacheConfigBuilder::default()
    .storage_file_path("geoverse.bin")
    .storage_flush_strategy(StorageFlushStrategy::Immediately)
    .build();

  let mut geo_cache = GeoCache::<DequeStorage>::new(config);

  geo_cache
    .insert(
      (48.1645819, 17.1847104, "sk"),
      "Bratislava, Slovakia".to_string(),
    )
    .expect("failed to insert address");

  let address = geo_cache
    .get((48.1645819, 17.1847104, "sk"))
    .expect("error while loading address")
    .expect("address not found");

  println!("{address}");
}
```

## Testing

Run the test suite:

```bash
cargo test
```

Run allocation tests:

```bash
cargo test --features "dhat-heap,testing" --test allocations -- --test-threads=1
```

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.