DMSCConfig

Struct DMSCConfig 

Source
pub struct DMSCConfig { /* private fields */ }
Expand description

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§

Source§

impl DMSCConfig

Source

pub fn new() -> Self

Creates a new empty configuration.

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

Source

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
Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

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
Source

pub fn clear(&mut self)

Clears all configuration values.

Removes all key-value pairs from the configuration.

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn count(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Clone for DMSCConfig

Source§

fn clone(&self) -> DMSCConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for DMSCConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'py> IntoPyObject<'py> for DMSCConfig

Source§

type Target = DMSCConfig

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl PyClass for DMSCConfig

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for DMSCConfig

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

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. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<DMSCConfig>

This handles following two situations: Read more
Source§

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

Immutable or mutable
Source§

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

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

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for DMSCConfig

Source§

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

Source§

impl PyMethods<DMSCConfig> for PyClassImplCollector<DMSCConfig>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for DMSCConfig

Source§

const NAME: &'static str = "DMSCConfig"

Class name.
Source§

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

Module name, if any.
Source§

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.
Source§

impl DerefToPyAny for DMSCConfig

Source§

impl ExtractPyClassWithClone for DMSCConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<'a, 'py, T> FromPyObject<'a, 'py> for T
where T: PyClass + Clone + ExtractPyClassWithClone,

§

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more
§

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<T, <T as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj. Read more
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
§

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

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

§

impl<T> Ungil for T
where T: Send,