Struct Tag

pub struct Tag {
    pub std_key: Option<StandardTagKey>,
    pub key: String,
    pub value: Value,
}

A Tag encapsulates a key-value pair of metadata.

Fields

std_key: Option<StandardTagKey>

If the Tag’s key string is commonly associated with a typical type, meaning, or purpose, then if recognized a StandardTagKey will be assigned to this Tag.

This is a best effort guess since not all metadata formats have a well defined or specified tag mapping. However, it is recommended that consumers prefer std_key over key, if provided.

key: String

A key string indicating the type, meaning, or purpose of the Tags value.

Note: The meaning of key is dependant on the underlying metadata format.

value: Value

The value of the Tag.

Implementations

impl Tag

pub fn new(std_key: Option<StandardTagKey>, key: &str, value: Value) -> Tag

Create a new Tag.

pub fn is_known(&self) -> bool

Returns true if the Tag’s key string was recognized and a StandardTagKey was assigned, otherwise false is returned.

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Display for Tag

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

Formats the value using the given formatter.