Struct StateRegistry 

pub struct StateRegistry { /* private fields */ }

The kernel’s persistent registry of module metadata and configuration.

Internally backed by an sqlx::SqlitePool. Cheaply cloneable.

Config values are optionally encrypted at rest with AES-256-GCM when the registry is opened via StateRegistry::open_encrypted (requires the encrypted Cargo feature).

Implementations

impl StateRegistry

pub async fn in_memory() -> Result<Self>

Create a new in-memory registry. Suitable for tests and early development.

pub async fn connect(path: &str) -> Result<Self>

Connect to an on-disk SQLite database. The file is created if missing.

pub async fn open_encrypted(path: &str, key_str: &str) -> Result<Self>

Open or create an encrypted on-disk registry.

Config values are stored as AES-256-GCM ciphertext; the key is derived from key_str via SHA-256. Module metadata rows remain plaintext.

To read the key from the environment use StateRegistry::key_from_env as the key_str argument.

Requires the encrypted Cargo feature.

pub fn key_from_env() -> Result<String>

Read the registry encryption key from the OXIDE_REGISTRY_KEY environment variable.

Returns an error if the variable is not set or is empty.

pub fn pool(&self) -> &SqlitePool

Read-only access to the underlying sqlx pool. Used by the XAI decision log and other in-kernel extensions that need to manage additional tables alongside the core registry schema.

pub async fn upsert_module( &self, metadata: &ModuleMetadata, state: ModuleState, ) -> Result<()>

Insert or update a module’s metadata.

pub async fn set_module_state(&self, id: &str, state: ModuleState) -> Result<()>

Update only the state column for a given module.

pub async fn get_module(&self, id: &str) -> Result<Option<ModuleRecord>>

Fetch a single module record by id.

pub async fn list_modules(&self) -> Result<Vec<ModuleRecord>>

List all module records.

pub async fn set_config<T: Serialize>(&self, key: &str, value: &T) -> Result<()>

Persist a configuration value. The value is serialized to JSON.

When the registry was opened via Self::open_encrypted the stored value is AES-256-GCM ciphertext; otherwise it is plain JSON.

pub async fn get_config<T: DeserializeOwned>(&self, key: &str) -> Result<T>

Fetch a configuration value and deserialize it. Returns KernelError::ConfigNotFound if the key does not exist.

Transparently decrypts when the registry is encrypted.

pub async fn try_get_config<T: DeserializeOwned>( &self, key: &str, ) -> Result<Option<T>>

Fetch a configuration value, returning None if missing instead of an error.

pub async fn delete_config(&self, key: &str) -> Result<bool>

Delete a configuration value. Returns true if a row was removed.

Trait Implementations

impl Clone for StateRegistry

fn clone(&self) -> StateRegistry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StateRegistry

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

Formats the value using the given formatter.