Skip to main content

ConfigDefinition

Struct ConfigDefinition 

Source
pub struct ConfigDefinition {
    pub key: &'static str,
    pub label_i18n_key: &'static str,
    pub description_i18n_key: &'static str,
    pub value_type: ConfigValueType,
    pub default_fn: fn() -> String,
    pub normalize_fn: Option<ConfigNormalizer>,
    pub dependency_validator_fn: Option<ConfigDependencyValidator>,
    pub requires_restart: bool,
    pub is_sensitive: bool,
    pub visibility: ConfigVisibility,
    pub category: &'static str,
    pub description: &'static str,
}
Expand description

Product-owned metadata for one configuration key.

Fields§

§key: &'static str

Stable storage key.

§label_i18n_key: &'static str

Frontend i18n key for the display label.

§description_i18n_key: &'static str

Frontend i18n key for the description.

§value_type: ConfigValueType

Storage and API value kind.

§default_fn: fn() -> String

Function returning the default storage value.

§normalize_fn: Option<ConfigNormalizer>

Optional product-owned value normalizer.

§dependency_validator_fn: Option<ConfigDependencyValidator>

Optional product-owned cross-field validator.

§requires_restart: bool

Whether changes require process restart before they can take effect.

§is_sensitive: bool

Whether values should be redacted in presentation and audit output.

§visibility: ConfigVisibility

Default consumer visibility for this system-defined value.

§category: &'static str

Product-defined category key.

§description: &'static str

Backend-facing description used when initializing storage rows.

Implementations§

Source§

impl ConfigDefinition

Source

pub const fn private_system() -> Self

Returns a baseline private system definition for struct update syntax.

Product registries usually repeat the same neutral metadata for most entries: system-owned source, private visibility, no normalizer, and no dependency validator. This helper keeps static definition lists compact while still requiring each product to spell out the storage key, type, default, category, and descriptions that define its public contract.

Trait Implementations§

Source§

impl Clone for ConfigDefinition

Source§

fn clone(&self) -> ConfigDefinition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfigDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for ConfigDefinition

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