feat: enhance ClockCache with iterators and documentation#63
Open
feat: enhance ClockCache with iterators and documentation#63
Conversation
Added `iter` and `iter_mut` methods to `ClockCache`, providing access to key-value pairs in slot order without setting reference bits. Updated documentation throughout the `ClockCache` struct to include examples for new methods, improved clarity on cache behavior, and ensured consistency in usage. Enhanced the `metrics_snapshot` method documentation with an example to illustrate its functionality. This change aims to improve usability and understanding of the `ClockCache` API.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added
iteranditer_mutmethods toClockCache, providing access to key-value pairs in slot order without setting reference bits. Updated documentation throughout theClockCachestruct to include examples for new methods, improved clarity on cache behavior, and ensured consistency in usage. Enhanced themetrics_snapshotmethod documentation with an example to illustrate its functionality. This change aims to improve usability and understanding of theClockCacheAPI.Description
Related Issue
Fixes #
Type of Change
How Has This Been Tested?
Test environment:
Checklist
cargo fmtandcargo clippycargo test)Screenshots (if applicable)
Additional Notes