Enum vector_config_common::attributes::CustomAttribute

pub enum CustomAttribute {
    Flag(String),
    KeyValue {
        key: String,
        value: Value,
    },
}

A custom attribute on a container, variant, or field.

Applied by using the #[configurable(metadata(...))] helper. Two forms are supported:

• as a flag (#[configurable(metadata(some_flag))])
• as a key/value pair (#[configurable(metadata(status = "beta"))])

Custom attributes are added to the relevant schema definition as a custom field, _metadata, and stored as an object. For key/value pairs, they are added as-is to the object. For flags, the flag name is the property name, and the value will always be true.

Variants

Flag(String)

A standalone flag.

Common for marking items as supporting a particular feature i.e. marking fields that can use the event template syntax.

KeyValue

A key/value pair.

Used for most metadata, where a given key could have many different possible values i.e. the status of a component (alpha, beta, stable, deprecated, etc).

Fields

key: String

value: Value

Implementations

impl CustomAttribute

pub fn flag<N>(name: N) -> Self

where N: Display,

pub fn kv<K, V>(key: K, value: V) -> Self

where K: Display, V: Serialize,

pub const fn is_flag(&self) -> bool

pub const fn is_kv(&self) -> bool

Trait Implementations

impl Clone for CustomAttribute

fn clone(&self) -> CustomAttribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomAttribute

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

Formats the value using the given formatter.