Struct TagIndex 

pub struct TagIndex { /* private fields */ }

Implementations

impl TagIndex

pub fn add(&mut self, tag: TeloidTag, id: TeloidID)

Adds a TeloidID to the index for a given TeloidTag.

If the tag does not exist in the index, it will be added. If the ID already exists for the given tag, it will not be added again.

Arguments

• tag - The TeloidTag to associate with the ID.
• id - The TeloidID to add.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};

let mut tag_index = TagIndex::new();
let tag = "test_tag";
let id = 1;
tag_index.add(tag, id);
tag_index.add(tag, id); // Duplicates are ignored
assert_eq!(tag_index.get(tag).unwrap().len(), 1);

pub fn get(&self, tag: &str) -> Option<&HashSet<TeloidID>>

Retrieves a reference to the set of TeloidIDs associated with a given TeloidTag.

Arguments

• tag - The TeloidTag to look up.

Returns

An Option containing a reference to the HashSet of TeloidIDs if the tag exists, otherwise None.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};
use std::collections::HashSet;

let mut tag_index = TagIndex::new();
let tag = "test_tag";
let id = 1;
tag_index.add(tag, id);

let mut expected = HashSet::new();
expected.insert(1);

let ids = tag_index.get(tag);
assert_eq!(ids, Some(&expected));

pub fn remove(&mut self, tag: &str, id: TeloidID)

Removes a TeloidID from the index for a given TeloidTag.

If the tag or ID does not exist, the index remains unchanged.

Arguments

• tag - The TeloidTag from which to remove the ID.
• id - The TeloidID to remove.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};

let mut tag_index = TagIndex::new();
let tag = "test_tag";
let id = 1;
tag_index.add(tag, id);
tag_index.remove(tag, id);
assert!(tag_index.get(tag).is_none() || tag_index.get(tag).unwrap().is_empty());

pub fn update(&mut self, tag: &str, id: TeloidID)

Adds a TeloidID to an existing entry for a given TeloidTag.

This is similar to add, but it will not create a new entry if the tag doesn’t exist.

Arguments

• tag - The TeloidTag to update.
• id - The TeloidID to add.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};

let mut tag_index = TagIndex::new();
let tag = "test_tag";
let id1 = 1;
let id2 = 2;
tag_index.add(tag, id1);
tag_index.update(tag, id2);
assert_eq!(tag_index.get(tag).unwrap().len(), 2);

pub fn contains_key(&self, tag: &str) -> bool

Checks if a TeloidTag exists in the index.

Arguments

• tag - The TeloidTag to check.

Returns

true if the tag exists, otherwise false.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};

let mut tag_index = TagIndex::new();
let tag = "test_tag";
tag_index.add(tag, 1);

assert!(tag_index.contains_key(tag));

pub fn len(&self) -> usize

Returns the number of tags in the index.

Returns

The number of unique tags in the index.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};

let mut tag_index = TagIndex::new();
tag_index.add("test_tag", 1);
assert_eq!(tag_index.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the index contains no elements.

Returns

true if the index is empty, false otherwise.

Examples

use deep_causality_ethos::TagIndex;

let mut tag_index = TagIndex::new();
assert!(tag_index.is_empty());
tag_index.add("test_tag", 1);
assert!(!tag_index.is_empty());

pub fn clear(&mut self)

Clears the index, removing all tags and IDs.

Examples

use deep_causality_ethos::{TagIndex, TeloidTag, TeloidID};

let mut tag_index = TagIndex::new();
tag_index.add("test_tag", 1);
tag_index.clear();
assert_eq!(tag_index.len(), 0);

impl TagIndex

pub fn new() -> Self

Creates a new, empty TagIndex.

Returns

A new TagIndex instance.

Examples

use deep_causality_ethos::TagIndex;
let tag_index = TagIndex::new();

pub fn with_capacity(capacity: usize) -> Self

Creates a new TagIndex with a specified capacity.

Arguments

• capacity - The initial capacity of the index.

Returns

A new TagIndex instance with the given capacity.

Examples

use deep_causality_ethos::TagIndex;
let tag_index = TagIndex::with_capacity(10);

Trait Implementations

impl Clone for TagIndex

fn clone(&self) -> TagIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TagIndex

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

Formats the value using the given formatter.

impl Default for TagIndex

fn default() -> TagIndex

Returns the “default value” for a type.

impl Display for TagIndex

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

Formats the value using the given formatter.

impl PartialEq for TagIndex

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TagIndex

impl StructuralPartialEq for TagIndex