Skip to content

Fix/store api guidelines#57

Merged
TKorr merged 3 commits intomainfrom
fix/store-api-guidelines
Mar 22, 2026
Merged

Fix/store api guidelines#57
TKorr merged 3 commits intomainfrom
fix/store-api-guidelines

Conversation

@TKorr
Copy link
Contributor

@TKorr TKorr commented Mar 22, 2026

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

TKorr added 3 commits March 22, 2026 13:52
Updated the documentation for `HandleStore` to improve clarity and consistency, including example usage with error handling. Enhanced the `StoreFull` struct with `Display` and `Error` trait implementations for better error reporting. Adjusted examples to use `?` for error propagation, ensuring a more idiomatic Rust style. This change aims to improve usability and understanding of the API.
Enhanced documentation for `HashMapStore` by updating examples to use `?` for error propagation, improving idiomatic Rust style. Added `StoreFull` to the import statements in examples to reflect the correct usage. This change aims to enhance clarity and usability for users interacting with the API.
Introduced optional `serde` dependency for enhanced serialization capabilities. Updated `Cargo.toml` to include `serde` and its derive feature, and modified `Cargo.lock` accordingly. Enhanced `StoreMetrics` struct with `serde` attributes for better compatibility with serialization frameworks. This change aims to improve the usability of the cache library in scenarios requiring data persistence or network transmission.
@TKorr TKorr merged commit e5c8f13 into main Mar 22, 2026
17 checks passed
@TKorr TKorr deleted the fix/store-api-guidelines branch March 22, 2026 16:03
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