Moka-py

Breaking Changes

- The following caches have been moved to a separate crate called
[Mini-Moka][mini-moka-crate]:
- `moka::unsync::Cache` → `mini_moka::unsync::Cache`
- `moka::dash::Cache` → `mini_moka::sync::Cache`
- The following methods have been removed from `sync` and `future` caches
([199][gh-pull-0199]). They were deprecated in v0.8.0:
- `get_or_insert_with` (Use `get_with` instead)
- `get_or_try_insert_with` (Use `try_get_with` instead)
- The following methods of `sync` and `future` caches have been marked as deprecated
([193][gh-pull-0193]):
- `get_with_if` (Use `entry` API's `or_insert_with_if` instead)

Added

- Add `entry` and `entry_by_ref` APIs to `sync` and `future` caches
([193][gh-pull-0193]):
- They allow users to perform more complex operations on a cache entry. At this
point, the following operations (methods) are provided:
- `or_default`
- `or_insert`
- `or_insert_with`
- `or_insert_with_if`
- `or_optionally_insert_with`
- `or_try_insert_with`
- The above methods return `Entry` type, which provides `is_fresh` method to
check if the value was freshly computed or already existed in the cache.

Fixed

- Fix an issue that `get_with` method of `future` cache inflates future size by ~7x,
sometimes causing stack overflow ([212][gh-issue-0212]):
- This was caused by a known `rustc` optimization issue on async functions
([rust-lang/rust62958][gh-rust-issue-62958]).
- Added a workaround to our cache and now it will only inflate the size by ~2.5x.
- Fix a bug that setting the number of segments of `sync` cache will disable
notifications. ([207][gh-issue-0207])

Added

- Add examples for `build_with_hasher` method of cache builders.
([216][gh-pull-0216])

Fixed

- Prevent race condition in `get_with` family methods to avoid evaluating `init`
closure or future multiple times in concurrent calls. ([195][gh-pull-0195])

Added

- Add `optionally_get_with` method to `sync` and `future` caches
([187][gh-pull-0187], by [LMJW][gh-LMJW]):
- It is similar to `try_get_with` but takes an init closure/future returning an
`Option<V>` instead of `Result<V, E>`.
- Add `by_ref` version of API for `get_with`, `optionally_get_with`, and
`try_get_with` of `sync` and `future` caches ([190][gh-pull-0190], by
[LMJW][gh-LMJW]):
- They are similar to the non-`by_ref` versions but take a reference of the key
instead of an owned key. If the key does not exist in the cache, the key will
be cloned to create new entry in the cache.

Changed

- Change the CI to run Linux AArch64 tests on real hardware using Cirrus CI.
([180][gh-pull-0180], by [ClSlaid][gh-ClSlaid])

Fixed

- Fix a typo in the documentation. ([189][gh-pull-0189], by [Swatinem][gh-Swatinem])

Fixed

- Fix memory leak after dropping a `sync` or `future` cache ([177][gh-pull-0177]):
- This leaked the value part of cache entries.

Added

- Add an experimental `js` feature to make `unsync` and `sync` caches to compile for
`wasm32-unknown-unknown` target ([173](gh-pull-0173), by [aspect][gh-aspect]):
- Note that we have not tested if these caches work correctly in wasm32
environment.

Added

- Add an option to the cache builder of the following caches not to start and use the
global thread pools for housekeeping tasks ([165][gh-pull-0165]):
- `sync::Cache`
- `sync::SegmentedCache`

Fixed

- Ensure that the following caches will drop the value of evicted entries immediately
after eviction ([169][gh-pull-0169]):
- `sync::Cache`
- `sync::SegmentedCache`
- `future::Cache`