Struct RiConfig 

pub struct RiConfig { /* private fields */ }

Basic configuration storage with typed access methods.

This struct provides a simple key-value store for configuration values, with type-safe methods for accessing values as different types.

Implementations

impl RiConfig

pub fn new() -> Self

Creates a new empty configuration.

Returns a new RiConfig instance with an empty key-value store.

pub fn is_sensitive_key(key: &str) -> bool

Checks if a configuration key is sensitive.

Security

This method checks if the key matches any sensitive patterns. Sensitive values should be masked when logging or displaying.

pub fn mask_sensitive_value(value: &str) -> String

Masks a sensitive value for safe display.

Security

This method masks the middle portion of a sensitive value, showing only the first 2 and last 2 characters.

pub fn get_masked(&self, key: &str) -> Option<String>

Gets a configuration value, masking sensitive values.

Security

This method returns the value, but masks it if the key is sensitive. Use this for logging or displaying configuration values.

pub fn all_values_masked(&self) -> FxHashMap<String, String>

Gets all configuration values with sensitive values masked.

Security

This method returns all key-value pairs with sensitive values masked. Use this for logging or displaying configuration.

pub fn set(&mut self, key: impl Into<String>, value: impl Into<String>)

Sets a configuration value.

Parameters

• key: The configuration key (typically using dot notation, e.g., “server.port”)
• value: The configuration value as a string

pub fn get(&self, key: &str) -> Option<&String>

Gets a configuration value as a string.

Parameters

• key: The configuration key to look up

Returns

An Option<&String> containing the value if it exists

pub fn get_str(&self, key: &str) -> Option<&str>

Gets a configuration value as a string slice.

Parameters

• key: The configuration key to look up

Returns

An Option<&str> containing the value if it exists

pub fn get_bool(&self, key: &str) -> Option<bool>

Gets a configuration value as a boolean.

Supports the following truthy values: “true”, “1”, “yes”, “on” Supports the following falsy values: “false”, “0”, “no”, “off”

Parameters

• key: The configuration key to look up

Returns

An Option<bool> containing the parsed boolean value if the key exists and can be parsed

pub fn get_i64(&self, key: &str) -> Option<i64>

Gets a configuration value as a 64-bit signed integer.

Parameters

• key: The configuration key to look up

Returns

An Option<i64> containing the parsed integer value if the key exists and can be parsed

pub fn get_i64_with_bounds(&self, key: &str, min: i64, max: i64) -> Option<i64>

Gets a configuration value as a 64-bit signed integer with bounds checking.

Parameters

• key: The configuration key to look up
• min: Minimum allowed value
• max: Maximum allowed value

Returns

An Option<i64> containing the parsed and validated integer value

pub fn get_u64(&self, key: &str) -> Option<u64>

Gets a configuration value as a 64-bit unsigned integer.

Parameters

• key: The configuration key to look up

Returns

An Option<u64> containing the parsed integer value if the key exists and can be parsed

pub fn get_u64_with_bounds(&self, key: &str, min: u64, max: u64) -> Option<u64>

Gets a configuration value as a 64-bit unsigned integer with bounds checking.

Parameters

• key: The configuration key to look up
• min: Minimum allowed value (default: 0)
• max: Maximum allowed value

Returns

An Option<u64> containing the parsed and validated integer value

pub fn get_positive_u64(&self, key: &str) -> Option<u64>

Gets a configuration value as a positive 64-bit unsigned integer (must be > 0).

Parameters

• key: The configuration key to look up

Returns

An Option<u64> containing the positive integer value

pub fn get_port(&self, key: &str) -> Option<u16>

Gets a configuration value as a port number (1-65535).

Parameters

• key: The configuration key to look up

Returns

An Option<u16> containing the valid port number

pub fn get_f32(&self, key: &str) -> Option<f32>

Gets a configuration value as a 32-bit floating point number.

Parameters

• key: The configuration key to look up

Returns

An Option<f32> containing the parsed float value if the key exists and can be parsed

pub fn get_f32_with_bounds(&self, key: &str, min: f32, max: f32) -> Option<f32>

Gets a configuration value as a 32-bit floating point number with bounds checking.

Parameters

• key: The configuration key to look up
• min: Minimum allowed value
• max: Maximum allowed value

Returns

An Option<f32> containing the parsed and validated float value

pub fn get_percentage(&self, key: &str) -> Option<f32>

Gets a configuration value as a percentage (0.0-100.0).

Parameters

• key: The configuration key to look up

Returns

An Option<f32> containing the percentage value

pub fn get_rate(&self, key: &str) -> Option<f32>

Gets a configuration value as a rate (0.0-1.0).

Parameters

• key: The configuration key to look up

Returns

An Option<f32> containing the rate value

pub fn merge(&mut self, other: &RiConfig)

Merges another configuration into this one.

Values from the other configuration will override existing values with the same keys.

Parameters

• other: The other configuration to merge into this one

pub fn clear(&mut self)

Clears all configuration values.

Removes all key-value pairs from the configuration.

pub fn get_or_default<T>(&self, key: &str, default: T) -> T

where T: FromStr, T::Err: Debug,

pub fn get_f64(&self, key: &str) -> Option<f64>

pub fn get_usize(&self, key: &str) -> Option<usize>

pub fn get_i32(&self, key: &str) -> Option<i32>

pub fn get_u32(&self, key: &str) -> Option<u32>

pub fn get_u32_with_bounds(&self, key: &str, min: u32, max: u32) -> Option<u32>

Gets a configuration value as a 32-bit unsigned integer with bounds checking.

Parameters

• key: The configuration key to look up
• min: Minimum allowed value
• max: Maximum allowed value

Returns

An Option<u32> containing the parsed and validated integer value

pub fn get_timeout_secs(&self, key: &str) -> Option<u32>

Gets a configuration value as a timeout value in seconds (1-86400).

Parameters

• key: The configuration key to look up

Returns

An Option<u32> containing the timeout in seconds

pub fn get_retry_count(&self, key: &str) -> Option<u32>

Gets a configuration value as a retry count (0-100).

Parameters

• key: The configuration key to look up

Returns

An Option<u32> containing the retry count

pub fn keys(&self) -> Vec<&str>

pub fn all_values(&self) -> Vec<&str>

pub fn has_key(&self, key: &str) -> bool

pub fn count(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for RiConfig

fn clone(&self) -> RiConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RiConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiConfig

type Target = RiConfig

The Python output type

type Output = Bound<'py, <RiConfig 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 RiConfig

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiConfig

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 = c"Basic configuration storage with typed access methods.\n\nThis struct provides a simple key-value store for configuration values, with\ntype-safe methods for accessing values as different types.\x00"

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<RiConfig>

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 RiConfig

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

impl PyMethods<RiConfig> for PyClassImplCollector<RiConfig>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiConfig

const NAME: &'static str = "RiConfig"

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 RiConfig

impl ExtractPyClassWithClone for RiConfig