- Add
Cached::cache_try_get_or_set_withfor parity with async trait
- Remove unnecessary string clones in redis cache store
- Update cargo default features manifest key
- Replace
instantwithweb_timein proc macro, update cached_proc_macro version
- Replace unmaintained
instantcrate withweb_time
- Propagate function generics to generated inner cache function
- Update
DiskCacheto requireToStringinstead ofDisplay
ExpiringSizedCache: Allow specifying explicit TTL when inserting
- Refactor
ExpiringSizedCacheinternals to not require tombstones ExpiringSizedCachekeys must implOrdExpiringSizedCacheremoveandinsertupdated to return only unexpired values
- Add
get_borrowedmethods toExpiringSizedCacheto support cache retrieval using&str/&[T]when the key types areString/Vec<T>. This is a workaround for issues implementingBorrowfor a generic wrapper type.
- Update documentation and add missing methods to
ExpiringSizedCache(clear, configuration methods)
ExpiringSizedCache: When allocating usingwith_capacity, allocate enough space to account for the default max number of tombstone entries
- Add
ExpiringSizedCacheintended for high read scenarios. Currently incompatible with the cached trait and macros.
- Add
DiskCacheBuilder::set_sync_to_disk_on_cache_changeto specify that the cache changes should be written to disk on every cache change. - Add
sync_to_disk_on_cache_changeto#[io_cached]to allow settingDiskCacheBuilder::set_sync_to_disk_on_cache_changefrom the proc macro. - Add
DiskCacheBuilder::set_connection_configto give more control over the sled connection. - Add
connection_configto#[io_cached]to allow settingDiskCacheBuilder::set_connection_configfrom the proc macro. - Add
DiskCache::connection()andDiskCache::connection_mut()to give access to the underlying sled connection. - Add
cache_unset_lifespanto cached traits for un-setting expiration on types that support it
- [Breaking]
typeattribute is nowty - Upgrade to syn2
- Corrected a typo in DiskCacheError (de)serialization variants
- Signature or
DiskCache::remove_expired_entries: this now returnsResult<(), DiskCacheError>instead of(), returning anErr(sled::Error)on removing and flushing from the connection.
- Fix
DiskCacheexpired value logic
- While handling cache refreshes in
DiskCache::cache_get, treat deserialization failures as non-existent values
- Fix
DiskCache::remove_expired_entriessignature
- Add DiskCache store
- Add
disk=true(and company) flags to#[io_cached]
- Include LICENSE file in
cached_proc_macroandcached_proc_macro_types
- Add
CloneCachedtrait with additional methods when the cache value type implementsClone - Add
result_fallbackoption tocachedproc_macro to support re-using expired cache values when utilizing an expiring cache store and a fallible function.
- Update redis
0.23.0->0.24.0
- Fix #once sync_writes bug causing a deadlock after ttl expiry, #174
- Add
ahashfeature to use the faster ahash algorithm. - Set
ahashas a default feature. - Update hashbrown
0.13.0->0.14.0
- Release
*_no_cachechanges from0.45.0. The change is in the proc macro crate which I forgot to release a new version of.
- Generate
*_no_cachefunction for every cached function to allow calling the original function without caching. This is backwards incompatible if you have a function with the same name.
tokiodependency has been removed fromproc_macrofeature (originally unecessarily included).asyncfeature has been removed from thedefaultfeature. This is a backwards incompatible change. If you want to useasyncfeatures, you need to enableasyncexplicitly.- remove accidental
#[doc(hidden)]on thestoresmodule
- Option to enable redis multiplex-connection manager on
AsyncRedisCache
-
Show proc-macro documentation on docs.rs
-
Document needed feature flags
-
Hide implementation details in documentation
-
Relax
Cachedtrait'scache_get,cache_get_mutandcache_removekey parameter. AllowK: Borrow<Q>likestd::collections::HashMapand friends. Avoids copies particularly onCached<String, _>where now you can docache.cache_get("key")and before you had tocache.cache_get("key".to_string()).Note: This is a minor breaking change for anyone manually implementing the
Cachedtrait. The signatures ofcache_get,cache_get_mut, andcache_removemust be updated to include the additional trait bound on thekeytype:fn cache_get<Q>(&mut self, key: &Q) -> Option<&V> where K: std::borrow::Borrow<Q>, Q: std::hash::Hash + Eq + ?Sized, {
- Dependency to
lazy_staticandasync_onceare removed.
- Update redis
0.22.0->0.23.0 - Update serial_test
0.10.0->2.0.0
- Better code generation for
#[cached]when thesync_writesflag is true.
- Fix "sized" cache types (
SizedCache,TimedSizedCache) to check capacity and evict members after insertion. - Fixes bug where continuously inserting a key present in the cache would incorrectly evict the oldest cache member even though the cache size was not increasing.
- Add optional feature flag
redis_ahashto enableredis's optionalahashfeature
- Update
redisto0.22.0 - Move
tokio'srt-multi-threadfeature from being a default to being optionally enabled byasync_tokio_rt_multi_thread - Fix makefile's doc target to match documentation, changed from
make synctomake docs
- Add flush method to ExpiringValueCache
- Fix proc macro argument documentation
- Disable futures
default-features - Add cache-remove to redis example
- Mark the auto-generated "priming" functions with
#[allow(dead_code)] - Fix documentation typos
- Replace dev/build scripts with a Makefile
- wasm support for non-io macros and stores
- Use
instantcrate for wasm compatible time
- Added
ExpiringValueCachefor caching values that can themselves expire. - Added COPYRIGHT file
- Make sure
AsyncRedisCacheBuilder,RedisCacheBuilder, andRedisCacheBuildErrorpublicly visible
- Replace
async-mutexandasync-rwlockused by proc-macros withtokio::syncversions - Add optional
versionfield toCachedRedisValuestruct - Cleanup feature flags so async redis features include
redis_storeandasyncfeatures automatically
- Allow specifying the namespace added to cache keys generated by redis stores
- Bump hashbrown 0.11.2 -> 0.12: https://github.com/rust-lang/hashbrown/blob/master/CHANGELOG.md#v0120---2022-01-17
- Bump smartstring 0.2 -> 1: https://github.com/bodil/smartstring/blob/master/CHANGELOG.md#100---2022-02-24
- Fix redis features so
redis/aiois only included when async redis features (redis_tokio/redis_async_std) are enabled
- Fix how doc strings are handled by proc-macros. Capture all documentation on the cached function definitions and add them to the function definitions generated by the proc-macros. Add doc strings to generated static caches. Link to relevant static caches in generated function definitions. Add documentation to the generated cache-priming function.
IOCachedandIOCachedAsynctraitsRedisCacheandAsyncRedisCachestore types- Add
#[io_cached]proc macro for defining cached functions backed by stores that implementIOCached/IOCachedAsync
- Convert from travis-ci to github actions
- Update build status badge to link to github actions
- Add flush method to TimedSize and TimedSized caches
- Fix timed/timed-sized cache-get/insert/remove to remove and not return expired values
- proc-macro: support arguments of the wrapped function being prefixed with
mut
- Add failable TimedSize and SizeCached constructors
- Add
time_refreshoption to#[cached]to refresh TTLs on cache hits - Generate
*_prime_cachefunctions for every#[cached]and#[once]function to allow priming caches.
- Add
sync_writesoption to#[cached]macro to synchronize concurrent function calls of duplicate arguments. For ex, if a long running#[cached(sync_writes = true)]function is called several times concurrently, the actual function is only executed once while all other calls block and return the newly cached value.
- Add
#[once]macro for create aRwLockcache wrapping a single value - For all caches, add a function to get an immutable reference to their contents. This makes it possible to manually dump a cache, so its contents can be saved and restored later.
- Update deps hashbrown and darling, remove async-mutex from cached-proc-macro crate
- Add option to "timed" caches to refresh the ttl of entries on cache hits
- Add docs strings to the items generated by the
#cachedproc macro
cache_reset_metricstrait method to reset hits/misses
- Refactor cache store types to separate modules
- Add support for returning a
cached::Returnwrapper type that indicates whether the result came from the function's cache.
- Support mutual
size&timeargs in the cached proc macro. Added when TimedSizedCache was added, but forgot to release the cached_proc_macro crate update.
- Add a TimedSizedCache combining LRU and timed/ttl logic
- Add new CachedAsync trait. Only present with async feature. Adds two async function in the entry API style of HashMap
- Add type hint
_result!macros - remove unnecessary transmute in cache reset
- remove unnecessary clones in proc macro
- use
async-mutexinstead of fullasync-std
- Store inner values when
result=trueoroption=true. TheErrortype in theResultnow no longer needs to implementClone.
- add
cache_set_lifespanto change the cache lifespace, old value returned.
- fix proc macro when result=true, regression from changing
cache_setto return the previous value
- add
Cachedimplementation for stdHashMap
- trait
Cachedhas a new methodcache_get_or_set_with cache_setnow returns the previous value if any
- add Clone, Debug trait derives on pub types
- fix proc macro documentation
- proc macro version
- async support when using the new proc macro version
- Add
cache_get_muttoCachedtrait, to allow mutable access for values in the cache. - Change the type of
hitsandmissesto beu64.
- Add
value_ordermethod to SizedCache, similar tokey_order
- add
cache_resettrait method for resetting cache collections to their initial state
- Update
once_cellto 1.x
- Replace SizedCache implementation to avoid O(n) lookup on cache-get
- Update to Rust-2018 edition
- cargo fmt everything
- Replace inner cache when "clearing" unbounded cache
- Switch to
once_cell. Library users no longer need to importlazy_static
- Add
cache_clearandcache_resulttoCachedtrait- Allows for defeating cache entries if desired
- Update documentation
- Note the in-memory nature of cache stores
- Note the behavior of memoized functions under concurrent access
- Fixed duplicate key eviction in
SizedCache::cache_set. This would manifest whencachedfunctions called with duplicate keys would race set an uncached key, or ifSizedCachewas used directly.
- Add
cached_resultandcached_key_resultto allow the caching of success for a function that returnsResult. - Add
cached_controlmacro to allow specifying functionality at key points of the macro
- Add
cached_keymacro to allow defining the caching key
- Tweak
cachedmacro syntax - Update readme
- Update trait docs
- Update readme
- Update examples
- Update crate documentation and examples