Struct ClawEngine 

pub struct ClawEngine { /* private fields */ }

The main entry point for claw-core.

Implementations

impl ClawEngine

pub async fn open(config: ClawConfig) -> ClawResult<Self>

Open (or create) the database at config.db_path.

pub async fn open_default() -> ClawResult<Self>

Open the database using default ClawConfig.

pub async fn migrate(&self) -> ClawResult<()>

Apply all pending embedded SQL migrations.

pub fn pool(&self) -> &SqlitePool

Return a reference to the underlying SQLx pool.

pub fn config(&self) -> &ClawConfig

Return a reference to the active configuration.

pub async fn close(self)

Close the connection pool, waiting for in-flight queries to complete.

pub async fn insert_memory(&self, record: &MemoryRecord) -> ClawResult<Uuid>

Insert a new MemoryRecord into the database and cache.

pub async fn get_memory(&self, id: Uuid) -> ClawResult<MemoryRecord>

Retrieve a MemoryRecord by id.

pub async fn update_memory(&self, id: Uuid, content: &str) -> ClawResult<()>

Update memory content and invalidate cache entry.

pub async fn delete_memory(&self, id: Uuid) -> ClawResult<()>

Delete a memory row and invalidate cache entry.

pub async fn list_memories( &self, type_filter: Option<MemoryType>, ) -> ClawResult<Vec<MemoryRecord>>

List memory rows, optionally filtered by type.

pub async fn list_memories_paginated( &self, type_filter: Option<MemoryType>, opts: ListOptions, ) -> ClawResult<ListPage<MemoryRecord>>

List memory rows with keyset pagination.

pub async fn get_memories_by_type( &self, memory_type: MemoryType, opts: Option<ListOptions>, ) -> ClawResult<ListPage<MemoryRecord>>

List memories by type with pagination.

pub async fn search_by_tag(&self, tag: &str) -> ClawResult<Vec<MemoryRecord>>

Search by exact tag using indexed lookup.

pub async fn search_by_tag_paginated( &self, tag: &str, limit: u32, offset: u32, ) -> ClawResult<Vec<MemoryRecord>>

Search by exact tag with explicit limit/offset.

pub async fn fts_search(&self, query: &str) -> ClawResult<Vec<MemoryRecord>>

Full-text search using SQLite FTS5.

pub async fn expire_ttl_memories(&self) -> ClawResult<u64>

Expire all memory rows whose TTL has elapsed.

pub async fn start_session(&self) -> ClawResult<String>

Start a new session and return its id.

pub async fn end_session(&self, session_id: &str) -> ClawResult<()>

Mark a session as ended.

pub async fn get_session(&self, session_id: &str) -> ClawResult<Session>

Retrieve a session lifecycle record.

pub async fn list_sessions( &self, opts: Option<ListOptions>, ) -> ClawResult<ListPage<Session>>

List sessions with keyset pagination.

pub async fn record_tool_output( &self, output: &ToolOutputRecord, ) -> ClawResult<()>

Record a tool-output entry.

pub async fn list_tool_outputs( &self, session_id: &str, ) -> ClawResult<Vec<ToolOutputRecord>>

List tool-output rows for a session.

pub async fn transaction(&self) -> ClawResult<ClawTransaction<'_>>

Begin a new transaction.

pub async fn begin_transaction(&self) -> ClawResult<ClawTransaction<'_>>

Begin a new transaction (alias of ClawEngine::transaction).

pub async fn snapshot(&self) -> ClawResult<PathBuf>

Create an atomic snapshot file under snapshot_dir.

pub async fn snapshot_create(&self) -> ClawResult<SnapshotMeta>

Backward-compatible snapshot helper that returns rich metadata.

pub async fn restore(&mut self, snapshot_path: &Path) -> ClawResult<()>

Restore the database from a snapshot file.

pub fn list_snapshots(&self) -> ClawResult<Vec<SnapshotManifest>>

Return all snapshot manifests sorted newest-first.

pub fn delete_snapshot(&self, path: &Path) -> ClawResult<()>

Delete a snapshot database file and its sidecar manifest.

pub async fn cache_stats(&self) -> CacheStats

Return a snapshot of current cache statistics.

pub async fn stats(&self) -> ClawResult<ClawStats>

Return comprehensive runtime statistics.

pub async fn db_stats(&self) -> ClawResult<DbStats>

Return database-level table counts.

Trait Implementations

impl Debug for ClawEngine

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.