Struct RiCacheModule 

pub struct RiCacheModule { /* private fields */ }

Main cache module for Ri.

This module provides a unified caching abstraction with support for multiple backend implementations. It implements both the AsyncServiceModule and ServiceModule traits for seamless integration into the Ri application lifecycle.

Implementations

impl RiCacheModule

pub async fn new(config: RiCacheConfig) -> Self

Creates a new cache module with the given configuration.

This method initializes the cache manager with the appropriate backend based on the provided configuration. The backend is created immediately, not as a placeholder.

Parameters

• config: The cache configuration to use

Returns

A new RiCacheModule instance

pub fn with_config(config: RiCacheConfig) -> Self

Creates a new cache module with the given configuration (synchronous version).

This is a synchronous wrapper around the async new method for use in the builder pattern. For Redis and Hybrid backends, it will block on the current thread to create the backend.

Parameters

• config: The cache configuration to use

Returns

A new RiCacheModule instance

pub fn cache_manager(&self) -> Arc<RwLock<RiCacheManager>>

Returns a reference to the cache manager.

The cache manager is wrapped in an Arc<RwLock<>> to allow thread-safe access from multiple async tasks.

Returns

An Arc<RwLock> providing thread-safe access to the cache manager

Trait Implementations

impl<'py> IntoPyObject<'py> for RiCacheModule

type Target = RiCacheModule

The Python output type

type Output = Bound<'py, <RiCacheModule as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiCacheModule

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiCacheModule

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// into the Ri application lifecycle.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiCacheModule>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiCacheModule

const TEXT_SIGNATURE: &'static str = "(config)"

impl PyMethods<RiCacheModule> for PyClassImplCollector<RiCacheModule>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiCacheModule

const NAME: &'static str = "RiCacheModule"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl RiModule for RiCacheModule

fn name(&self) -> &str

Returns the name of the cache module.

Returns

The module name as a string

fn is_critical(&self) -> bool

Indicates whether the cache module is critical.

The cache module is non-critical, meaning that if it fails to initialize or operate, it should not break the entire application. This allows the core functionality to continue even if caching features are unavailable.

Returns

false since cache is non-critical

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Initializes the cache module asynchronously.

This method performs the following steps:

1. Loads configuration from the service context
2. Updates the module configuration if provided
3. Initializes the appropriate cache backend based on configuration
4. Creates and sets the cache manager with the initialized backend

Parameters

• ctx: The service context containing configuration and other services

Returns

A RiResult<()> indicating success or failure

fn after_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Performs asynchronous cleanup after the application has shut down.

This method performs the following steps:

1. Prints cache statistics
2. Cleans up expired cache entries
3. Prints cleanup results

Parameters

• _ctx: The service context (not used in this implementation)

Returns

A RiResult<()> indicating success or failure

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn before_start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Prepares the module for startup.

fn start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Starts the service module.

fn after_start<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Performs post-startup operations.

fn before_shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Prepares the module for shutdown.

fn shutdown<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 mut RiServiceContext, ) -> Pin<Box<dyn Future<Output = RiResult<()>> + Send + 'async_trait>>

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

Shuts down the service module.

impl ServiceModule for RiCacheModule

fn name(&self) -> &str

Returns the name of the service module.

fn is_critical(&self) -> bool

Indicates if the module is critical to the operation of the system.

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn init(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Initializes the service module.

fn start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Starts the service module.

fn shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Shuts down the service module.

fn before_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for startup.

fn after_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-startup operations.

fn before_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for shutdown.

fn after_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-shutdown cleanup.

impl DerefToPyAny for RiCacheModule

impl ExtractPyClassWithClone for RiCacheModule