Struct config_it::shared::meta::Metadata

pub struct Metadata {
    pub name: &'static str,
    pub varname: &'static str,
    pub type_name: &'static str,
    pub flags: MetaFlag,
    pub editor_hint: Option<MetadataEditorHint>,
    pub description: &'static str,
    pub env: Option<&'static str>,
}

Describes metadata for a configuration entity, intended for utilization by external tools.

Fields

name: &'static str

Unique identifier for this configuration entity.

varname: &'static str

Source variable name from the configuration definition. It’s typically identical to ‘name’ unless an alternative name is explicitly set.

type_name: &'static str

String representation of the type for this configuration entity.

flags: MetaFlag

Flags that denote various behaviors and hints associated with the configuration entity.

editor_hint: Option<MetadataEditorHint>

Provides guidance for a monitoring editor on how to interact with this variable. While this crate doesn’t use this hint directly, it helps external monitors understand the preferred method to edit the variable.

description: &'static str

A brief description that elaborates on the purpose or role of the configuration entity.

env: Option<&'static str>

Corresponding environment variable name, if any, that maps to this configuration entity.

Trait Implementations

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Deserialize<'static> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.