Struct KeywordCollection 

pub struct KeywordCollection { /* private fields */ }

A collection of keyword instances on a card. Mirrors Java’s KeywordCollection which uses a Multimap<Keyword, KeywordInterface>.

Serializes as a Vec<String> of original keyword strings for backward compatibility.

Implementations

impl KeywordCollection

pub fn new() -> Self

Create a new empty keyword collection.

pub fn from_strings(strings: &[String]) -> Self

Build a KeywordCollection from a Vec<String>.

pub fn contains_keyword(&self, keyword: Keyword) -> bool

Whether the collection contains any instance of the given keyword.

pub fn is_empty(&self) -> bool

Whether the collection is empty.

pub fn size(&self) -> usize

Total number of keyword instances.

pub fn get_amount(&self, keyword: Keyword) -> i32

Get the total amount for a keyword (sum of all instances).

pub fn insert(&mut self, inst: KeywordInstanceData) -> bool

Insert a keyword instance data. Returns true if it was added.

pub fn add(&mut self, k: &str) -> bool

Add a keyword from a string, parsing it into the appropriate type.

pub fn add_all<'a>(&mut self, keywords: impl IntoIterator<Item = &'a str>)

Add all keywords from string iterator.

pub fn remove(&mut self, keyword: &str) -> bool

Remove all instances whose original string starts with the given prefix.

pub fn remove_all(&mut self, keyword: Keyword) -> bool

Remove all instances of a keyword enum variant.

pub fn remove_strings<'a>( &mut self, keywords: impl IntoIterator<Item = &'a str>, ) -> bool

Remove keywords matching any of the given strings.

pub fn clear(&mut self)

Clear all keywords.

pub fn contains_string(&self, keyword: &str) -> bool

Check if collection contains a keyword by exact original string match.

pub fn contains_string_ignore_case(&self, keyword: &str) -> bool

Check if collection contains a keyword by case-insensitive original string match.

pub fn any_starts_with(&self, prefix: &str) -> bool

Check if any keyword’s original string starts with the given prefix.

pub fn any_starts_with_ignore_case(&self, prefix: &str) -> bool

Check if any keyword’s original string starts with the given prefix (case-insensitive).

pub fn find_with_prefix(&self, prefix: &str) -> Option<&str>

Find the first keyword whose original string starts with the given prefix.

pub fn iter_strings(&self) -> impl Iterator<Item = &str>

Iterate over original keyword strings.

pub fn retain<F: Fn(&str) -> bool>(&mut self, f: F)

Retain only keywords matching a predicate on the original string.

pub fn extend(&mut self, other: impl IntoIterator<Item = String>)

Extend this collection with keywords from another collection.

pub fn get_values(&self) -> Vec<&KeywordInstanceData>

Get all keyword instance data as a flat list.

pub fn get_values_for(&self, keyword: Keyword) -> Vec<&KeywordInstanceData>

Get all keyword instances for a specific keyword.

pub fn contains(&self, keyword: &str) -> bool

Check if the collection contains a keyword by string prefix match. Mirrors Java’s KeywordCollection.contains(String).

pub fn insert_all(&mut self, keywords: &[KeywordInstanceData])

Insert all keyword instance data from a slice. Mirrors Java’s KeywordCollection.insertAll(Iterable<KeywordInterface>).

pub fn remove_instances(&mut self, keyword: &str)

Remove all instances of a specific keyword string (exact match). Mirrors Java’s KeywordCollection.removeInstances(Keyword, String).

pub fn apply_changes(&mut self, additions: &[String], removals: &[String])

Apply a batch of keyword additions and removals. Mirrors Java’s KeywordCollection.applyChanges(KeywordsChange).

pub fn iterator(&self) -> impl Iterator<Item = &str>

Iterate over keyword strings. Alias for iter_strings for parity with Java’s KeywordCollection.iterator().

pub fn as_string_list(&self) -> Vec<String>

Get all keywords as a list of original strings.

Trait Implementations

impl Clone for KeywordCollection

fn clone(&self) -> KeywordCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeywordCollection

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

Formats the value using the given formatter.

impl Default for KeywordCollection

fn default() -> KeywordCollection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeywordCollection

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for KeywordCollection

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.