pub enum RiCacheEvent {
Invalidate {
key: String,
},
InvalidatePattern {
pattern: String,
},
Clear(),
}Expand description
§Ri Cache Manager
This file implements a cache manager that coordinates different cache backends with consistency support across multiple instances. It provides a unified interface for cache operations while ensuring cache consistency through event-driven architecture.
§Design Principles
- Consistency First: Ensures cache consistency across multiple instances using broadcast events
- Unified Interface: Provides a consistent API regardless of the underlying cache backend
- Event-Driven Architecture: Uses broadcast channels for efficient cache invalidation
- Thread Safety: Implements thread-safe operations using Arc and RwLock
- Flexibility: Supports any backend implementing the RiCache trait
- Scalability: Designed to handle high-throughput cache operations
§Usage Examples
// Create a cache manager with a Redis backend
let redis_backend = Arc::new(RiRedisBackend::new(config).await?);
let mut cache_manager = RiCacheManager::new(redis_backend);
// Start the consistency listener
let listener_handle = cache_manager.start_consistency_listener().await;
// Set a value in cache
cache_manager.set("user:123", &User { id: 123, name: "John" }, Some(3600)).await?;
// Get a value from cache
let user: Option<User> = cache_manager.get("user:123").await?;
// Delete a value and invalidate across all instances
cache_manager.delete("user:123").await?;
// Clear cache and broadcast to all instances
cache_manager.clear().await?;Cache event type for maintaining cache consistency across instances
This enum defines the events that are broadcasted to ensure all cache instances remain consistent. Each event triggers a corresponding action on all cache instances.
Variants§
Invalidate
Invalidate a specific cache key
Parameters:
key: The cache key to invalidate
InvalidatePattern
Invalidate all cache keys matching a pattern
Parameters:
pattern: The pattern to match cache keys (supports wildcards depending on backend)
Clear()
Clear all cache entries
Trait Implementations§
Source§impl Clone for RiCacheEvent
impl Clone for RiCacheEvent
Source§fn clone(&self) -> RiCacheEvent
fn clone(&self) -> RiCacheEvent
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for RiCacheEvent
impl Debug for RiCacheEvent
Source§impl<'de> Deserialize<'de> for RiCacheEvent
impl<'de> Deserialize<'de> for RiCacheEvent
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl<'py> IntoPyObject<'py> for RiCacheEvent
impl<'py> IntoPyObject<'py> for RiCacheEvent
Source§type Target = RiCacheEvent
type Target = RiCacheEvent
The Python output type
Source§type Output = Bound<'py, <RiCacheEvent as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <RiCacheEvent as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for RiCacheEvent
impl PyClass for RiCacheEvent
Source§impl PyClassBaseType for RiCacheEvent
impl PyClassBaseType for RiCacheEvent
type LayoutAsBase = PyClassObject<RiCacheEvent>
type BaseNativeType = <RiCacheEvent as PyClassImpl>::BaseNativeType
type Initializer = PyClassInitializer<RiCacheEvent>
type PyClassMutability = <RiCacheEvent as PyClassImpl>::PyClassMutability
Source§impl PyClassImpl for RiCacheEvent
impl PyClassImpl for RiCacheEvent
Source§const IS_BASETYPE: bool = true
const IS_BASETYPE: bool = true
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// remain consistent. Each event triggers a corresponding action on all cache instances.
const RAW_DOC: &'static CStr = /// remain consistent. Each event triggers a corresponding action on all cache instances.
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<RiCacheEvent>
type ThreadChecker = SendablePyClass<RiCacheEvent>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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>
Source§impl PyTypeInfo for RiCacheEvent
impl PyTypeInfo for RiCacheEvent
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
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
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object is an instance of this type.Source§impl Serialize for RiCacheEvent
impl Serialize for RiCacheEvent
impl ExtractPyClassWithClone for RiCacheEvent
Auto Trait Implementations§
impl Freeze for RiCacheEvent
impl RefUnwindSafe for RiCacheEvent
impl Send for RiCacheEvent
impl Sync for RiCacheEvent
impl Unpin for RiCacheEvent
impl UnsafeUnpin for RiCacheEvent
impl UnwindSafe for RiCacheEvent
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.§fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information and unbinding it
from the 'py lifetime.§fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
Converts
self into a Python object. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
§fn type_check(object: &Bound<'_, PyAny>) -> bool
fn type_check(object: &Bound<'_, PyAny>) -> bool
§fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
Returns the expected type as a possible argument for the
isinstance and issubclass function. Read more