fix: max_files integer underflow when set to zero
#3348
Conversation
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.
Motivation
When
max_filesset to zero, rolling.rs:695 will cause integer underflow and panicking in debug build. In my opinion the API should prevent this from happening as "zero" is a validusizevalue to pass in.Solution
Currently, in release builds, if
max_filesis set to zero, it behaves just likeu64::MAXonx86_64platforms. Therefore, I decided to simply makezero == None, which should align with the existing behavior but without the panicking. I believe this can be considered as "non-breaking".Feel free to advise if there a more preferred way of fixing this. Any help on how to provide tests would also be appreciated!