fix(buffer): assert non-zero bound on construction#867
Open
Alpy16 wants to merge 2 commits into
Open
Conversation
Collaborator
|
Probably the docs on the constructor should also mention that the value must be greater than 0, maybe in a |
Author
|
I'll add the # Panics section to the documentation for both constructors right now and get those pushed up. Thanks for the review |
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.
Closes #861
Description
Initializing Buffer or BufferLayer with a capacity bound of 0 creates an invalid configuration state. This bypasses initial validation and causes an unrecoverable runtime panic down the line when the underlying mpsc::channel allocation is executed.
This patch adds a defensive assert!(bound > 0, ...) boundary guard to both the BufferLayer::new and Buffer::pair constructors. This shifts a latent runtime crash into a predictable, fail-fast initialization panic.
Type of Change
Bug fix (non-breaking change enforcing defensive API boundaries)
Verification
Added #[should_panic] integration tests to tower/tests/buffer/main.rs to verify that both direct instantiation and layer application fail safely when configured with a bound of 0.
Verified workspace tests pass via cargo test --test buffer --all-features.