Struct SQLiteSet 

pub struct SQLiteSet { /* private fields */ }

A hash set with string keys, backed by an SQLite in-memory database.

By default, SQLiteSet treats its keys as case-sensitive, but a case-insensitive variant is available. Even when using the case-sensitive set variant, for some operations a dedicated “case-insensitive” version is provided.

Important: For bulk inserts or updates, it is strongly recommended to use an explicit transaction. Without one, SQLite executes each insert or update in its own transaction, which can significantly degrade performance.

Implementations

impl SQLiteSet

pub fn new() -> Result<Self, Error>

Creates a new, empty SQLite-backed hash set with case-sensitive keys.

pub fn with_nocase() -> Result<Self, Error>

Creates a new, empty SQLite-backed hash set with case-insensitive keys.

pub fn transaction(&mut self) -> Result<SQLiteSetTransaction<'_>, Error>

Starts a new SQLite transaction for this set.

Please note that using an explicit SQLite transaction allows for much more efficient bulk inserts 🚀

Returns the new SQLiteSetTransaction instance.

pub fn insert(&mut self, key: &str) -> Result<bool, Error>

Inserts the given key into the set.

Returns true, if the set did not already contain the key; otherwise returns false.

pub fn contains(&self, key: &str) -> Result<bool, Error>

Checks whether the set contains the specified key.

For case-sensitive sets, the check is case-sensitive; for case-insensitive sets, the check is case-insensitive.

Returns true, if the set contains the key; otherwise returns false.

pub fn contains_nocase(&self, key: &str) -> Result<bool, Error>

This is the “case-insensitive” version of the contains() function.

The check is always performed case-insensitive.

Returns true, if the set contains the key; otherwise returns false.

pub fn remove(&mut self, key: &str) -> Result<bool, Error>

Removes the specified key from the set, if present.

For case-sensitive sets, the key is treated as case-sensitive; for case-insensitive sets, it is treated as case-insensitive.

Returns true, if the set contained the key; otherwise returns false.

pub fn remove_nocase(&mut self, key: &str) -> Result<bool, Error>

This is the “case-insensitive” version of the remove() function.

The key is always treated as case-insensitive.

Returns true, if the set contained the key; otherwise returns false.

pub fn for_each<F>(&self, callback: F) -> Result<(), Error>

where F: FnMut(&str),

Invokes the given callback function for each key that is currently contained in the set.

This function does not guarantee a specific iteration order.

pub fn find<P>(&self, predicate: P) -> Result<Option<String>, Error>

where P: Fn(&str) -> bool,

Searches the set for the first key that satisfies the given predicate.

Returns the first key that satisfies the given predicate, or None if no key satisfies the predicate or the set is empty.

This function does not guarantee a specific iteration order.

Also, the predicate is not always tested on all keys, because the function returns at the first match.

pub fn len(&self) -> Result<SizeT, Error>

Returns the number of unique keys in the set.

pub fn is_empty(&self) -> Result<bool, Error>

Returns true if the set contains no keys; otherwise returns false.

pub fn clear(&mut self) -> Result<(), Error>

Removes all keys from the set.

Trait Implementations

impl Default for SQLiteSet

fn default() -> Self

Returns a new, empty set, as created by the SQLiteSet::new() function.

Panics

Panics if a new SQLiteSet instance could not be created, e.g., because of an SQLite error.