kora-embedded

Embeddable library mode for the Kōra cache engine.

This crate provides [Database], a high-level API for using Kōra as an in-process library rather than a standalone network server. It wraps the same multi-threaded ShardEngine that powers kora-server, but eliminates all network overhead: commands are serialised into the engine's internal Command enum and dispatched through per-shard channels directly from the calling thread.

How it works

Each [Database] instance owns a ShardEngine with a configurable number of shard worker threads. Keys are hashed to a shard, and the corresponding command is sent over an mpsc channel to that shard's worker. The calling thread blocks on a oneshot channel until the worker replies, giving synchronous semantics with lock-free, shared-nothing execution on the data path.

Embedded vs. server mode

Hybrid mode

With the server Cargo feature enabled, [Database::start_listener] spawns a TCP server alongside the embedded instance, allowing external clients to connect while the host process retains direct API access.

Quick start

use kora_embedded::{Config, Database};

let db = Database::open(Config::default());
db.set("greeting", b"hello world");
assert_eq!(db.get("greeting"), Some(b"hello world".to_vec()));