Skip to content

Conversation

@sandersaares
Copy link
Member

@sandersaares sandersaares commented Dec 15, 2025

Updates API documentation with new and improved terminology. One step of many - further iterations for API docs improvement will follow.

Removes the requirement to go through bytes::Buf and bytes::BufMut traits when performing reads/writes on BytesBuf/BytesView. These traits are still implemented but now there are also equivalent inherent methods (sometimes with better signatures, no longer trying to maintain parity with bytes API signatures).

In a later iteration, the bytes compatibility traits will move behind a feature flag - not fully rooted out yet from all the places.

Removes usage of bytes::Buf and bytes::BufMut from examples, relying on inherent bytesbuf methods only.

Improved panic documentation and assertion logic with regard to some obscure cases like exceeding usize::MAX.

@codecov
Copy link

codecov bot commented Dec 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (32e413b) to head (8298a04).
⚠️ Report is 59 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##             main     #132     +/-   ##
=========================================
  Coverage   100.0%   100.0%             
=========================================
  Files          33       90     +57     
  Lines        3291     6373   +3082     
=========================================
+ Hits         3291     6373   +3082     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants