plugmem_host/
lib.rs

1//! Native host layer for the plugmem engine: file-backed storage with
2//! exclusive locking, a thread-safe database handle with a maintenance
3//! policy, and embedding providers.
4//!
5//! This crate is the "point it at a file and go" Rust experience:
6//!
7//! ```no_run
8//! use plugmem_host::{Config, Database, RecallQuery, RememberInput};
9//!
10//! let (db, _report) = Database::open("agent.plugmem", Config::default())?;
11//! db.remember(RememberInput::text(1_784_000_000_000, "prefers tokio"))?;
12//! let out = db.recall(RecallQuery::text(1_784_000_100_000, "runtime?"))?;
13//! println!("{}", out.rendered);
14//! # Ok::<(), plugmem_host::HostError>(())
15//! ```
16//!
17//! Concurrency model: one file has one owning process —
18//! a second open is refused with [`HostError::Locked`]; within the
19//! process, clone the [`Database`] handle across threads and agents;
20//! different files are fully independent. Embedding calls run outside
21//! the database lock.
22//!
23//! With the default `config` feature, the host also accepts the shared
24//! `config.toml` format through [`Settings::load`] and [`read_config`]. The
25//! `SETTINGS.md` file is the reference documentation for that format, not an
26//! input file. Disable the feature with `default-features = false` when a
27//! caller wants only programmatic [`Config`] construction.
28
29mod db;
30mod embedder;
31mod error;
32mod paths;
33mod readonly;
34#[cfg(feature = "config")]
35mod settings;
36#[cfg(feature = "config")]
37mod settings_help;
38mod storage;
39mod workspace;
40
41pub use db::{Database, DatabaseBuilder, ExportPage, ExportedFact, FactSnapshot, RecoverReport};
42pub use embedder::{Embedder, NullEmbedder, OpenAiCompatEmbedder, SharedEmbedder};
43pub use error::HostError;
44pub use paths::{default_config_dir, default_config_path, default_data_dir, default_database_path};
45pub use readonly::{ReadOnlyDatabase, Scrub};
46#[cfg(feature = "config")]
47pub use settings::{Settings, SettingsError, WorkspaceSettings, read_config};
48#[cfg(feature = "config")]
49pub use settings_help::{SettingDoc, SettingScope, SettingsHelp, settings_help};
50pub use storage::{FileScratch, FileStorage, FsyncPolicy};
51pub use workspace::{
52    ARCHIVED_TAG, DEFAULT_IDLE_TIMEOUT_MS, DEFAULT_MAX_OPEN, DbEntry, DbName, Description,
53    ENTRY_TAG, IfMissing, MAX_DB_NAME, MAX_OPEN_CEILING, NameProblem, Opener, ReindexReport,
54    SELF_ENTITY, Workspace, WorkspaceError, WorkspaceIssue, WorkspaceLayout, WorkspaceLimits,
55};
56
57// The engine types a host caller works with, re-exported so simple
58// embedders need only this crate.
59pub use plugmem_core::snapshot::{DEFAULT_SCRUB_BUDGET, ScrubProgress};
60pub use plugmem_core::{
61    Config, EdgeId, EntityId, Error, FactId, FactRecord, LinkInput, MaintainReport,
62    MaintenanceMode, MaintenanceOptions, OpenReport, RecallQuery, RecallResult, RecallScratch,
63    RecalledEdge, RecalledFact, RememberInput, RememberOutcome, ShardLayout, Similar,
64    SimilarReason, Stats, UnlinkInput, VALID_TO_OPEN, fact_flags,
65};
66pub use plugmem_core::{MemScratch, Scratch};
plugmem_host/lib.rs

plugmem_host/
lib.rs
