Document large input behavior and compilation limits#45
Merged
leighmcculloch merged 2 commits intomainfrom Feb 25, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates crate and macro documentation to set expectations around compile-time cost for large literals and to point users to include_bytes! for large byte data.
Changes:
- Added crate-level documentation noting the macros are intended for small inputs and may be slow for very large literals.
- Added the same guidance to
bytes!andbytesmin!macro docs, recommendinginclude_bytes!for large byte payloads.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dmkozh
approved these changes
Feb 24, 2026
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.
What
Add documentation to the crate-level docs and both
bytes!andbytesmin!macros explaining that they are intended for small inputs and that large inputs may cause long compilation times, directing users toinclude_bytes!as an alternative.Why
Users encountering slow compilation with large byte literals have no guidance on expected behavior or alternatives. This makes the tradeoff explicit and points to the standard library solution.