Trait DataApi

Source

pub trait DataApi {
    // Required methods
    fn push_data_ctx(
        &self,
        key: &str,
        value: Value,
        ttl: Option<Duration>,
    ) -> Result<(), DataError>;
    fn get_data_ctx(&self, key: &str) -> Result<Option<Value>, DataError>;
    fn get_data_entry_ctx(
        &self,
        key: &str,
    ) -> Result<Option<DataEntry>, DataError>;
    fn remove_data_ctx(&self, key: &str) -> Result<bool, DataError>;
    fn clear_data_ctx(&self) -> Result<(), DataError>;
    fn list_data_ctx(&self) -> Result<Vec<DataEntry>, DataError>;
    fn get_stats_ctx(&self) -> Result<DataStoreStats, DataError>;
}

Expand description

Trait defining the public API for data store operations.

This trait provides a consistent interface for pushing, retrieving, and managing data in the store. All operations are thread-safe.

The Cedarling struct implements this trait, providing access to the data store through the main application instance.

§Example

use cedarling::{Cedarling, DataApi, DataError};
use serde_json::json;
use std::time::Duration;

fn use_data_api(cedarling: &Cedarling) -> Result<(), DataError> {
    // Push data with a 5-minute TTL
    cedarling.push_data_ctx(
        "user_roles",
        json!(["admin", "editor"]),
        Some(Duration::from_secs(300)),
    )?;

    // Retrieve data
    if let Some(roles) = cedarling.get_data_ctx("user_roles")? {
        println!("User roles: {}", roles);
    }

    // List all entries with metadata
    for entry in cedarling.list_data_ctx()? {
        println!("Key: {}, Type: {:?}", entry.key, entry.data_type);
    }

    // Get store statistics
    let stats = cedarling.get_stats_ctx()?;
    println!("Entries: {}/{}", stats.entry_count, stats.max_entries);

    // Remove data
    cedarling.remove_data_ctx("user_roles")?;

    // Clear all data
    cedarling.clear_data_ctx()?;

    Ok(())
}