Struct RiConfigManager 

pub struct RiConfigManager { /* private fields */ }

Public-facing configuration manager with hot reload support.

This struct manages multiple configuration sources, loads configuration values, and provides access to the configuration. It supports hot reload and multiple configuration formats.

Implementations

impl RiConfigManager

pub fn new() -> Self

Creates a new empty configuration manager.

Returns a new RiConfigManager instance with no configuration sources.

pub fn with_hooks(hooks: Arc<RiHookBus>) -> Self

Creates a new configuration manager with the provided hook bus.

This method allows the config manager to emit hooks when configuration is reloaded.

Parameters

• hooks: The hook bus to use for emitting events

Returns

A new RiConfigManager instance with the provided hook bus

pub fn add_file_source(&mut self, path: impl AsRef<Path>)

Adds a file-based configuration source.

Parameters

• path: The path to the configuration file

Supported file formats: JSON, YAML, TOML

pub fn add_environment_source(&mut self)

Adds environment variables as a configuration source.

Environment variables with the prefix Ri_ are loaded as configuration values. Double underscores (__) in environment variable names are converted to dots. For example, Ri_SERVER__PORT=8080 becomes server.port=8080.

pub fn load(&mut self) -> Result<(), RiError>

Loads configuration from all registered sources.

This method loads configuration from all registered sources in the order they were added, with later sources overriding earlier ones.

Returns

A Result<(), RiError> indicating success or failure

pub fn new_default() -> Self

Creates a new configuration manager with default sources.

This method creates a new RiConfigManager with the following default sources:

1. Configuration files in the config directory (dms.yaml, dms.yml, dms.toml, dms.json)
2. Environment variables with the prefix Ri_

It also loads the configuration immediately.

Returns

A new RiConfigManager instance with default sources and loaded configuration

pub async fn start_watcher(&mut self) -> Result<(), RiError>

Starts the configuration watcher for hot reload.

This method starts watching all registered file-based configuration sources for changes. When a configuration file is modified, it will be automatically reloaded and the change callback (if registered) will be invoked.

Returns

A Result<(), RiError> indicating success or failure

pub async fn start_watcher_with_callback<F>( &mut self, callback: Option<Arc<dyn Fn() + Send + Sync>>, ) -> Result<(), RiError>

Starts the configuration watcher with a custom change callback.

This method starts watching all registered file-based configuration sources for changes. When a configuration file is modified, it will be automatically reloaded and the provided callback will be invoked.

Parameters

• callback: Optional callback function to invoke when configuration changes

Returns

A Result<(), RiError> indicating success or failure

pub async fn stop_watcher(&mut self) -> Result<(), RiError>

Stops the configuration watcher.

This method stops the configuration watcher and cleans up associated resources.

Returns

A Result<(), RiError> indicating success or failure

pub async fn get_monitored_paths(&self) -> Vec<PathBuf>

Gets the list of monitored configuration file paths.

Returns

A vector of paths being monitored for changes

pub fn config(&self) -> RiConfig

Gets a reference to the loaded configuration.

Returns

A RiConfig clone of the loaded configuration

pub fn config_mut(&mut self) -> RwLockWriteGuard<'_, RiConfig>

Gets a mutable reference to the loaded configuration.

Returns

A std::sync::RwLockWriteGuard<RiConfig> for the loaded configuration

Trait Implementations

impl Clone for RiConfigManager

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RiConfigManager

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiConfigManager

type Target = RiConfigManager

The Python output type

type Output = Bound<'py, <RiConfigManager as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiConfigManager

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiConfigManager

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// configuration formats.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiConfigManager>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiConfigManager

const TEXT_SIGNATURE: &'static str = "()"

impl PyMethods<RiConfigManager> for PyClassImplCollector<RiConfigManager>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiConfigManager

const NAME: &'static str = "RiConfigManager"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for RiConfigManager

impl ExtractPyClassWithClone for RiConfigManager