Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs(primitives): report some Bytes methods may panic #877

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

thedevbirb
Copy link
Contributor

@thedevbirb thedevbirb commented Feb 18, 2025

Motivation

Some methods of the Bytes struct call the underlying implementation from the bytes crate but their docs do not outline that they might panic.

Solution

Added documentation to note which methods may panic inheriting the docs from the bytes crate

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

@mattsse mattsse enabled auto-merge (squash) February 18, 2025 12:06
@mattsse mattsse merged commit aa80b5a into alloy-rs:main Feb 18, 2025
30 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants