Struct tusk_data::metadata::MetaData

pub struct MetaData {
    pub labels: Labels,
    pub tags: Tags,
}

Fields

labels: Labels

tags: Tags

Methods

impl MetaData

pub fn new() -> Self

Returns a new instance of MetaData

let m = tusk_data::metadata::MetaData::new();

pub fn add_tag(&mut self, tag: &str) -> &mut Self

Adds a new tag to the MetaData

assert_eq!(tusk_data::metadata::MetaData::new()
            .add_tag("example")
            .add_tag("another_tag")
            .tags, 
        vec!("example".to_string(), "another_tag".to_string())
    );

pub fn get_tags(&self) -> Tags

Returns all the Tags for this piece of MetaData

assert_eq!(tusk_data::metadata::MetaData::new()
            .add_tag("example")
            .add_tag("another_tag")
            .get_tags(), 
        vec!("example".to_string(), "another_tag".to_string())
    );

pub fn add_label(&mut self, name: &str, value: &str) -> &mut Self

Adds a new label to this piece of MetaData

let mut expect = tusk_data::metadata::Labels::new();
expect.insert("example".to_string(), "value".to_string());
assert_eq!(tusk_data::metadata::MetaData::new()
            .add_label("example", "value")
            .labels, expect);

pub fn get_labels(&self) -> Labels

Returns all Labels for this piece of MetaData

let mut expect = tusk_data::metadata::Labels::new();
expect.insert("example".to_string(), "value".to_string());
assert_eq!(tusk_data::metadata::MetaData::new()
            .add_label("example", "value")
            .get_labels(), expect);

pub fn superset(&self, md: &MetaData) -> bool

Returns true if the labels of the MetaData on the LHS are a superset of the labels of the MetaData on the RHS.

let mut base = tusk_data::metadata::MetaData::new();
base.add_label("example", "value");
let mut cover = tusk_data::metadata::MetaData::new();
cover.add_label("example", "value");
cover.add_label("example2", "value2");
assert!(cover.superset(&base));
assert!(!base.superset(&cover));
// If the two are equal then they are supersets of each other
assert!(base.superset(&base));

pub fn compile(&self) -> MetaDataFilter

Compiles the regexes so that the MetaData into a MetaDataFilter can be matched against other MetaData. Any failures are simply skipped over and not added to the filter.

assert_eq!(tusk_data::metadata::MetaData::new()
    .add_label("test", "value")
    .add_tag("example")
    .compile()
    .labels
    .len(), 1);
assert_eq!(tusk_data::metadata::MetaData::new()
    .add_label("test", "value")
    .add_tag("bad_tag")
    .compile()
    .tags
    .len(), 1);

Trait Implementations

impl Clone for MetaData

fn clone(&self) -> MetaData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetaData

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

Formats the value using the given formatter.

impl Ord for MetaData

fn cmp(&self, other: &MetaData) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialEq for MetaData

fn eq(&self, other: &MetaData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MetaData) -> bool

This method tests for !=.

impl PartialOrd for MetaData

fn partial_cmp(&self, other: &MetaData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MetaData) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MetaData) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MetaData) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MetaData) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for MetaData

impl Default for MetaData

fn default() -> Self

Returns a default implementation of the MetaData

let m = tusk_data::metadata::MetaData::default();