Struct DirectoryConfigStore 

pub struct DirectoryConfigStore { /* private fields */ }

Available on crate feature directory-config only.

Directory-based config store with YAML files as tables.

Each YAML file in the configured directory represents a “table”. Files are cached in memory and refreshed by background polling. Write operations use advisory file locking and optionally commit changes via git.

Implementations

impl DirectoryConfigStore

pub async fn new( config: DirectoryConfigStoreConfig, ) -> DirectoryConfigResult<Self>

Create a new store. Validates the directory exists and detects write mode. Does NOT start background refresh – call start() for that.

pub async fn start(&mut self) -> DirectoryConfigResult<()>

Start background polling refresh.

pub async fn stop(&mut self) -> DirectoryConfigResult<()>

Stop background polling refresh.

pub async fn list_tables(&self) -> Vec<String>

List all table names (YAML filenames without extension).

pub async fn get(&self, table: &str) -> DirectoryConfigResult<Value>

Get the entire contents of a table as a YAML value.

Table names may include subdirectory prefixes (e.g. loaders/dfe-loader).

pub async fn get_key( &self, table: &str, key: &str, ) -> DirectoryConfigResult<Value>

Get a specific key from a table using dot-notation path.

For example, get_key("loaders/dfe-loader", "kafka.brokers") navigates into the nested YAML structure. Dot separates keys, slash separates subdirectory path components in the table name.

pub async fn get_as<T: DeserializeOwned>( &self, table: &str, ) -> DirectoryConfigResult<T>

Deserialise a table into a typed struct.

Table names may include subdirectory prefixes (e.g. loaders/dfe-loader).

pub async fn set( &self, table: &str, key: &str, value: Value, message: Option<&str>, ) -> DirectoryConfigResult<WriteResult>

Set a key in a table. Creates the table file if it doesn’t exist.

Returns ReadOnly error if the store is not writable.

pub async fn delete_key( &self, table: &str, key: &str, message: Option<&str>, ) -> DirectoryConfigResult<WriteResult>

Delete a key from a table.

Returns ReadOnly error if the store is not writable. Returns TableNotFound if the table doesn’t exist. Returns KeyNotFound if the key doesn’t exist.

pub fn on_change(&self) -> Receiver<ChangeEvent>

Subscribe to change events for a specific table (or all tables).

Returns a broadcast receiver that receives ChangeEvents. Pass an empty string to receive events for all tables.

pub fn write_mode(&self) -> WriteMode

Get the current write mode.

pub fn is_git(&self) -> bool

Check if this store is backed by a git repository.

Trait Implementations

impl Debug for DirectoryConfigStore

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

Formats the value using the given formatter.