refactor: enhance time management and documentation in cache library#136
Open
TKorr wants to merge 1 commit into
Open
refactor: enhance time management and documentation in cache library#136TKorr wants to merge 1 commit into
TKorr wants to merge 1 commit into
Conversation
- Simplified the `duration_to_ticks` function to use `try_from` for better clarity and error handling. - Improved the `Clock` trait documentation, adding examples for better usability and understanding. - Updated `StdClock` and `MockClock` implementations with additional examples to demonstrate usage. - Refined the `ExpirationIndex` to utilize a `Deadline` type instead of `u64`, enhancing type safety and clarity in deadline management. - Expanded documentation across various components to improve clarity and provide practical examples for users. These changes enhance the overall usability and maintainability of the cache library, particularly in the context of time-based operations and expiration management.
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
1 participant
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.
duration_to_ticksfunction to usetry_fromfor better clarity and error handling.Clocktrait documentation, adding examples for better usability and understanding.StdClockandMockClockimplementations with additional examples to demonstrate usage.ExpirationIndexto utilize aDeadlinetype instead ofu64, enhancing type safety and clarity in deadline management.These changes enhance the overall usability and maintainability of the cache library, particularly in the context of time-based operations and expiration management.
Description
Related Issue
Fixes #
Type of Change
How Has This Been Tested?
Test environment:
Checklist
cargo fmtandcargo clippycargo test)Screenshots (if applicable)
Additional Notes