Struct Cache

pub struct Cache { /* private fields */ }

Implementations

impl Cache

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

Creates a new Cache instance.

This function establishes a connection to a Redis server and returns a Result containing the Cache instance if successful, or a Boxed error if an error occurs.

Errors

Returns a Boxed error if:

• The URL for the Redis server is invalid or unreachable.
• The connection to the Redis server cannot be established.

Example

    use celp_sdk::cache::Cache;

    let cache = Cache::new();

pub fn add_field( &mut self, key: &str, field: &str, value: &[u8], ) -> Result<i32, CacheError>

Adds a field and its corresponding value to a Redis hash.

Arguments

• key - The key of the Redis hash.
• field - The field to set.
• value - The value to set for the field.

Example

use celp_sdk::cache::Cache;

let cache = Cache::new();
if let Ok(mut c) = cache {
    c.add_field("celp:app_info", "restful-svc", "serialized-version-str".as_bytes());
}

pub fn get_fields( &mut self, key: &str, ) -> Result<HashMap<String, String>, CacheError>

Retrieves all fields and their corresponding values for a key from a Redis hash.

Arguments

• key - The key of the Redis hash.

Example

use celp_sdk::cache::Cache;

let cache = Cache::new();
if let Ok(mut c) = cache {
    let data = c.get_fields("celp:app_info");
}

pub fn get_field_names(&mut self, key: &str) -> Result<Vec<String>, CacheError>

Retrieves all field names from a Redis hash for a given key.

Arguments

• key - The key of the Redis hash.

Example

use celp_sdk::cache::Cache;

let cache = Cache::new();
if let Ok(mut c) = cache {
    let field_names = c.get_field_names("celp:app_info");
}

pub fn get_field_value( &mut self, key: &str, field: &str, ) -> Result<Option<String>, CacheError>

Retrieves a specific field’s value from a Redis hash.

Arguments

• key - The key of the Redis hash.
• field - The field whose value you want to retrieve.

Example

use celp_sdk::cache::Cache;

let cache = Cache::new();
if let Ok(mut c) = cache {
    let value = c.get_field_value("celp:app_info", "field_name");
}

pub fn field_exists( &mut self, key: &str, field: &str, ) -> Result<bool, CacheError>

Checks if a specific field exists in a Redis hash.

Arguments

• key - The key of the Redis hash.
• field - The field you want to check for existence.

Example

use celp_sdk::cache::Cache;

let cache = Cache::new();
if let Ok(mut c) = cache {
    let exists = c.field_exists("celp:app_info", "field_name");
}

pub fn delete_field( &mut self, key: &str, field: &str, ) -> Result<bool, CacheError>

Deletes a specific field from a Redis hash.

Arguments

• key - The key of the Redis hash.
• field - The field you want to delete.

Example

use celp_sdk::cache::Cache;

let cache = Cache::new();
if let Ok(mut c) = cache {
    let deleted = c.delete_field("celp:app_info", "field_name");
}