pub struct RiCachedValue {
pub value: String,
pub expires_at: Option<u64>,
pub last_accessed: Option<u64>,
}Expand description
Cached value wrapper with TTL and LRU support.
This struct encapsulates a cached value along with metadata for cache management:
- value: The actual cached data as a string
- expires_at: Optional TTL-based expiration timestamp (UNIX epoch seconds)
- last_accessed: Optional last access timestamp for LRU eviction policies
§Examples
use ri::cache::RiCachedValue;
let cached = RiCachedValue::new("test_data".to_string(), Some(3600));
assert!(!cached.is_expired());
cached.touch();
assert!(!cached.is_stale(300));Fields§
§value: StringThe cached value as a string
expires_at: Option<u64>Optional expiration timestamp (UNIX epoch seconds) If None, the value never expires based on TTL
last_accessed: Option<u64>Optional last access timestamp (UNIX epoch seconds) Used for LRU-based cache eviction policies
Implementations§
Source§impl RiCachedValue
impl RiCachedValue
Sourcepub fn new(value: String, ttl_seconds: Option<u64>) -> Self
pub fn new(value: String, ttl_seconds: Option<u64>) -> Self
Creates a new cached value with optional TTL.
§Parameters
value: The string value to cachettl_seconds: Optional time-to-live in seconds- If Some(seconds), the value will expire after the specified duration
- If None, the value never expires based on TTL
§Behavior
- Initializes
last_accessedto current timestamp for LRU tracking - Calculates
expires_atas current_time + ttl_seconds if TTL is provided
§Examples
use ri::cache::RiCachedValue;
// Create a value that expires in 1 hour
let cached = RiCachedValue::new("data".to_string(), Some(3600));
// Create a value that never expires
let persistent = RiCachedValue::new("persistent".to_string(), None);pub fn deserialize<T: DeserializeOwned>(&self) -> RiResult<T>
pub fn is_expired(&self) -> bool
Sourcepub fn touch(&mut self)
pub fn touch(&mut self)
Updates the last access timestamp to current time.
This method should be called each time the cached value is accessed to support LRU (Least Recently Used) cache eviction policies.
§Behavior
- Sets
last_accessedto the current UNIX timestamp - Does not modify
expires_atorvalue
§Use Cases
- LRU cache implementations tracking access order
- Cache warming strategies based on access patterns
- Usage analytics and cache performance monitoring
Sourcepub fn is_stale(&self, max_idle_secs: u64) -> bool
pub fn is_stale(&self, max_idle_secs: u64) -> bool
Checks if the cached value is stale based on idle time.
A value is considered stale if it has not been accessed for longer than the specified maximum idle time. This is useful for LRU eviction.
§Parameters
max_idle_secs: Maximum idle time in seconds before considering stale
§Returns
trueif the value is stale (not accessed within max_idle_secs)falseif the value is still fresh or has no access timestamp
§Examples
use ri::cache::RiCachedValue;
let mut cached = RiCachedValue::new("data".to_string(), None);
// Immediately after creation, not stale
assert!(!cached.is_stale(300));
cached.touch();
assert!(!cached.is_stale(300));Trait Implementations§
Source§impl Clone for RiCachedValue
impl Clone for RiCachedValue
Source§fn clone(&self) -> RiCachedValue
fn clone(&self) -> RiCachedValue
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RiCachedValue
impl Debug for RiCachedValue
Source§impl<'de> Deserialize<'de> for RiCachedValue
impl<'de> Deserialize<'de> for RiCachedValue
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>,
Source§impl<'py> IntoPyObject<'py> for RiCachedValue
impl<'py> IntoPyObject<'py> for RiCachedValue
Source§type Target = RiCachedValue
type Target = RiCachedValue
Source§type Output = Bound<'py, <RiCachedValue as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <RiCachedValue as IntoPyObject<'py>>::Target>
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>
Source§impl PyClass for RiCachedValue
impl PyClass for RiCachedValue
Source§impl PyClassImpl for RiCachedValue
impl PyClassImpl for RiCachedValue
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
Source§const RAW_DOC: &'static CStr = /// ```
const RAW_DOC: &'static CStr = /// ```
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<RiCachedValue>
type ThreadChecker = SendablePyClass<RiCachedValue>
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
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 PyClassNewTextSignature for RiCachedValue
impl PyClassNewTextSignature for RiCachedValue
const TEXT_SIGNATURE: &'static str = "(value, ttl_seconds)"
Source§impl PyMethods<RiCachedValue> for PyClassImplCollector<RiCachedValue>
impl PyMethods<RiCachedValue> for PyClassImplCollector<RiCachedValue>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for RiCachedValue
impl PyTypeInfo for RiCachedValue
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
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
object is an instance of this type.Source§impl Serialize for RiCachedValue
impl Serialize for RiCachedValue
impl DerefToPyAny for RiCachedValue
impl ExtractPyClassWithClone for RiCachedValue
Auto Trait Implementations§
impl Freeze for RiCachedValue
impl RefUnwindSafe for RiCachedValue
impl Send for RiCachedValue
impl Sync for RiCachedValue
impl Unpin for RiCachedValue
impl UnsafeUnpin for RiCachedValue
impl UnwindSafe for RiCachedValue
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
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>
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>
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>
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>
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>
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>
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>
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
§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>
isinstance and issubclass function. Read more