Skip to content

feat: enhance ClockCache with iterators and documentation#63

Open
TKorr wants to merge 1 commit intomainfrom
fix-clock-api-guidelines
Open

feat: enhance ClockCache with iterators and documentation#63
TKorr wants to merge 1 commit intomainfrom
fix-clock-api-guidelines

Conversation

@TKorr
Copy link
Copy Markdown
Contributor

@TKorr TKorr commented Mar 27, 2026

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.

Description

Related Issue

Fixes #

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🧪 Test addition or modification

How Has This Been Tested?

  • Unit tests
  • Integration tests
  • Manual testing

Test environment:

  • OS:
  • Rust version:

Checklist

  • My code follows the project's coding standards
  • I have run cargo fmt and cargo clippy
  • I have added tests for my changes
  • All new and existing tests pass (cargo test)
  • I have updated the documentation as needed
  • I have added an entry to CHANGELOG.md (if applicable)

Screenshots (if applicable)

Additional Notes

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant