Struct SqliteBackend

pub struct SqliteBackend { /* private fields */ }

A SQLite-based storage backend for PersistentMap.

This backend stores key-value pairs in a SQLite database, providing durable persistence with good performance characteristics.

Examples

use persistent_map::{PersistentMap, Result};
use persistent_map::sqlite::SqliteBackend;

// Create a SQLite backend
let backend = SqliteBackend::new("my_database.db").await?;

// Initialize a PersistentMap with the backend
let map: PersistentMap<String, String, _> = PersistentMap::new(backend).await?;

Implementations

impl SqliteBackend

pub async fn new(db_path: &str) -> Result<Self>

Creates a new SQLite backend with the given database path.

This method opens a connection to the SQLite database at the specified path and creates the necessary table if it doesn’t exist.

Arguments

• db_path - The path to the SQLite database file

Returns

A Result containing the new SqliteBackend or an error

Examples

use persistent_map::sqlite::SqliteBackend;
use persistent_map::Result;

let backend = SqliteBackend::new("my_database.db").await?;

Errors

Returns an error if the database connection cannot be opened or if the initial table/index creation fails.

pub async fn db_path(&self) -> Result<String>

Returns the path to the SQLite database file.

Returns

A Result containing the path to the database file or an error

Errors

Returns an error if the PRAGMA database_list query fails or if the path cannot be retrieved from the query result.

Trait Implementations

impl Debug for SqliteBackend

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

Formats the value using the given formatter.

impl<K, V> StorageBackend<K, V> for SqliteBackend

where K: Eq + Hash + Clone + Serialize + DeserializeOwned + Send + Sync + 'static + ToString + FromStr, <K as FromStr>::Err: Error + Send + Sync + 'static, V: Clone + Serialize + DeserializeOwned + Send + Sync + 'static,

Implementation of the StorageBackend trait for SqliteBackend.

This implementation provides methods for loading, saving, and deleting key-value pairs from a SQLite database.

fn load_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<K, V>, PersistentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Loads all key-value pairs from the SQLite database.

This method queries the database for all key-value pairs and deserializes them into the appropriate types.

fn save<'life0, 'async_trait>( &'life0 self, key: K, value: V, ) -> Pin<Box<dyn Future<Output = Result<(), PersistentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Saves a key-value pair to the SQLite database.

This method serializes the key and value to strings and inserts or replaces them in the database.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, ) -> Pin<Box<dyn Future<Output = Result<(), PersistentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deletes a key-value pair from the SQLite database.

This method removes the key-value pair with the specified key from the database.

Errors

Returns an error if deleting from the backend fails.

fn flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), PersistentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Flushes any buffered writes to the SQLite database.

This method ensures that all data is written to disk by executing a PRAGMA synchronous command.

fn contains_key<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, ) -> Pin<Box<dyn Future<Output = Result<bool, PersistentError>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if a key exists in the storage backend.

fn len<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<usize, PersistentError>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Get the number of key-value pairs in the storage backend.

fn is_empty<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool, PersistentError>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Check if the storage backend is empty.