Struct SalukiAnnotation 

pub struct SalukiAnnotation {
    pub schema: &'static SchemaEntry,
    pub support_level: SupportLevel,
    pub additional_yaml_paths: &'static [&'static str],
    pub env_var_override: Option<&'static [&'static str]>,
    pub used_by: &'static [&'static str],
    pub value_type_override: Option<ValueType>,
    pub test_json: Option<&'static str>,
    pub pipeline_affinity: PipelineAffinity,
}

Saluki-specific annotation for a single configuration key.

Fields

schema: &'static SchemaEntry

The schema entry this annotation enriches.

support_level: SupportLevel

How well saluki supports this key.

additional_yaml_paths: &'static [&'static str]

Additional YAML paths beyond the canonical one in the schema (aliases).

env_var_override: Option<&'static [&'static str]>

Overrides the schema’s env_vars list entirely when Some.

used_by: &'static [&'static str]

Config structs that incorporate this key, as structs constants.

value_type_override: Option<ValueType>

Overrides the schema’s value_type when Some.

test_json: Option<&'static str>

Overrides the smoke-test injected value entirely when Some.

pipeline_affinity: PipelineAffinity

Which pipelines this key affects.

Implementations

impl SalukiAnnotation

pub fn yaml_path(&self) -> &'static str

The canonical YAML path for this key (from the schema).

pub fn all_yaml_paths(&self) -> impl Iterator<Item = &'static str>

All YAML paths for this key: canonical first, then any aliases.

pub fn effective_env_vars(&self) -> &'static [&'static str]

Effective env vars: the override list if set, otherwise the schema’s list.

pub fn value_type(&self) -> ValueType

Shape of the value: override if set, otherwise from the schema.

Trait Implementations

impl Debug for SalukiAnnotation

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

Formats the value using the given formatter.

impl From<&SalukiAnnotation> for ConfigKey

fn from(a: &SalukiAnnotation) -> Self

Converts to this type from the input type.