loco-rs 0.6.1

The one-person framework for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! # Null Cache Driver
//!
//! The Null Cache Driver is the default cache driver implemented when the Loco
//! framework is initialized. The primary purpose of this driver is to simplify
//! the user workflow by avoiding the need for feature flags or optional cache
//! driver configurations.
use async_trait::async_trait;

use super::CacheDriver;
use crate::cache::{CacheError, CacheResult};

/// Represents the in-memory cache driver.
pub struct Null {}

/// Creates a new null cache instance
///
/// # Returns
///
/// A boxed [`CacheDriver`] instance.
#[must_use]
pub fn new() -> Box<dyn CacheDriver> {
    Box::new(Null {})
}

#[async_trait]
impl CacheDriver for Null {
    /// Checks if a key exists in the cache.
    ///
    /// # Errors
    ///
    /// Returns always error
    async fn contains_key(&self, _key: &str) -> CacheResult<bool> {
        Err(CacheError::Any(
            "Operation not supported by null cache".into(),
        ))
    }

    /// Retrieves a value from the cache based on the provided key.
    ///
    /// # Errors
    ///
    /// Returns always error
    async fn get(&self, _key: &str) -> CacheResult<Option<String>> {
        Ok(None)
    }

    /// Inserts a key-value pair into the cache.
    ///
    /// # Errors
    ///
    /// Returns always error
    async fn insert(&self, _key: &str, _value: &str) -> CacheResult<()> {
        Err(CacheError::Any(
            "Operation not supported by null cache".into(),
        ))
    }

    /// Removes a key-value pair from the cache.
    ///
    /// # Errors
    ///
    /// Returns always error
    async fn remove(&self, _key: &str) -> CacheResult<()> {
        Err(CacheError::Any(
            "Operation not supported by null cache".into(),
        ))
    }

    /// Clears all key-value pairs from the cache.
    ///
    /// # Errors
    ///
    /// Returns always error
    async fn clear(&self) -> CacheResult<()> {
        Err(CacheError::Any(
            "Operation not supported by null cache".into(),
        ))
    }
}