rig-memory-policy 0.2.1

Backend-agnostic memory-policy primitives (frame metadata, content-hash dedup) shared by Rig memory-store adapters.
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

# rig-memory-policy

[![Crates.io](https://img.shields.io/crates/v/rig-memory-policy.svg)](https://crates.io/crates/rig-memory-policy)
[![Documentation](https://docs.rs/rig-memory-policy/badge.svg)](https://docs.rs/rig-memory-policy)
[![CI](https://github.com/ForeverAngry/rig-memory-policy/actions/workflows/ci.yml/badge.svg)](https://github.com/ForeverAngry/rig-memory-policy/actions/workflows/ci.yml)

Backend-agnostic memory-policy primitives shared across [Rig](https://crates.io/crates/rig-core)
memory-store adapters (e.g. [`rig-memvid`](https://crates.io/crates/rig-memvid)
and future SQLite / LanceDB / Qdrant / filesystem backends).

This crate has **no** dependency on `memvid-core` or any specific storage
engine. Adapters wrap these primitives in their own backend-specific code.

## Public surface

- [`dedup`](https://docs.rs/rig-memory-policy/latest/rig_memory_policy/dedup/index.html)
  — in-process content-hash dedup for hooks/compactors that must satisfy
  `rig::memory::{DemotionHook, Compactor}`'s idempotency contract on
  `(conversation_id, messages)`.
- [`metadata`](https://docs.rs/rig-memory-policy/latest/rig_memory_policy/metadata/index.html)
  — typed envelope (`FrameMetadata` + `FrameKind`) written into a backend's
  per-entry metadata map so downstream tools (evals, memory inspectors, RAG
  pipelines) can reason about the lifecycle that produced each entry.
- [`store`](https://docs.rs/rig-memory-policy/latest/rig_memory_policy/store/index.html)
  — small capability traits (`TextWriter` + `Committable`) for hooks,
  compactors, and adapters that need to write text and explicitly flush it
  without depending on a concrete storage backend.
- [`inmem`](https://docs.rs/rig-memory-policy/latest/rig_memory_policy/inmem/index.html)
  — deterministic no-disk lexical reference store (`Episode`,
  `InMemoryStore`, `InMemoryHit`) for tests, examples, offline modes, and
  backend-neutral fixtures.
- [`error::PolicyError`](https://docs.rs/rig-memory-policy/latest/rig_memory_policy/error/enum.PolicyError.html)
  — neutral error type shared by the helpers above.

## Adapter pattern

Backend crates keep ownership of their storage-specific APIs while leaning on
these shared primitives for policy-level behaviour. For example,
[`rig-memvid`](https://crates.io/crates/rig-memvid) wraps Memvid's `.mv2`
archive format, but re-exports this crate's dedup, metadata, in-memory, and
text-write capability surfaces to preserve its historic public paths.

New backend-neutral code should prefer importing directly from
`rig-memory-policy`:

```rust,no_run
use rig_memory_policy::{Episode, InMemoryStore};

#[derive(Clone)]
struct Finding {
    summary: String,
}

impl Episode for Finding {
    fn summary(&self) -> &str {
        &self.summary
    }
}

# async fn run() -> Result<(), rig_memory_policy::PolicyError> {
let store = InMemoryStore::<Finding>::new();
store
    .append(Finding {
        summary: "scheduled maintenance".into(),
    })
    .await?;
let hits = store.retrieve_similar("maintenance", 5).await?;
assert_eq!(hits.len(), 1);
# Ok(()) }
```

Existing `rig-memvid` callers can continue using `rig_memvid::inmem::*` and
the top-level `rig_memvid::{Episode, InMemoryStore, InMemoryHit}` re-exports;
those are compatibility shims over this crate.

## License

MIT