Skip to content

feat(stabilization)!: bytesbuf_io 1.0 - #644

Draft
martintmk wants to merge 2 commits into
mainfrom
user/martintomka/20260806-add-bytesbuf-io
Draft

martintmk wants to merge 2 commits into
mainfrom
user/martintomka/20260806-add-bytesbuf-io

Conversation

@martintmk

@martintmk martintmk commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

Adds pending stabilization notes for the bytesbuf_io crate based on O365 Core work item 7688115. The notes record the proposed owned-buffer I/O boundary, current and proposed trait requirements, read and write semantics, ecosystem adapter strategy, and unresolved review items. Also adds an empty docs/DESIGN.md placeholder.

Validation

  • just package=bytesbuf_io format
  • just package=bytesbuf_io readme
  • cargo check -p bytesbuf_io --all-features
  • cargo build -p bytesbuf_io --all-features
  • cargo test -p bytesbuf_io --all-features
  • git diff --check
  • GitHub required checks passed, including repository spellcheck and CodeQL.
  • Codecov reports 100% project and patch coverage.
  • Multi-model review completed with no unresolved findings.

Local spellcheck was attempted, but the installed cargo-spellcheck process exits during startup on this machine. The GitHub spell-check job passed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 95a89ae9-292f-4300-878a-ac61ade1eb7b
@martintmk martintmk added the agency-rocket Touched by a rocket skill label Aug 6, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 95a89ae9-292f-4300-878a-ac61ade1eb7b
@codecov

codecov Bot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (d799037) to head (5553dbe).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #644   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files         473      473           
  Lines       45493    45493           
=======================================
  Hits        45493    45493           
Flag Coverage Δ
linux ?
linux-arm ?
scheduled ?
windows ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

@martintmk martintmk left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Posted by an AI agent

Two non-blocking stabilization-documentation findings remain.

Coverage: Complete current-head review covered API design, correctness, tests, performance, naming, telemetry, resilience, consistency, public API, and public documentation. This is a documentation-only change; the package build passed and no runtime or test behavior changed.

Vote: Not requested because the authenticated reviewer owns this PR.

at usage sites. Removing the current requirement changes guarantees available to
downstream callers. The stable contract should not impose cross-thread execution
when an implementation and its caller are both thread-local.
- Select the concrete error boundary. The associated error type and the crate's

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Posted by an AI agent · Non-blocking

The stable error boundary does not cover recovery classification

Problem
The stabilization decisions cover the associated error type and wrapper composition, but do not decide whether transient/unavailable classifications and retry-delay hints must survive conversion into the crate error.

Why this matters
Once the traits stabilize, adding a required recovery contract can become a breaking change, while callers cannot reliably drive retries or circuit breakers if wrapping erases that information.

Suggested fix
Add recovery classification and preservation to the error-boundary checklist, including an explicit decision if this lower-level crate intentionally leaves classification to adapters.


## Pending review

- [ ] Review the trait shape against `arty_io`, TCP, and fetch use cases.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Posted by an AI agent · Non-blocking

The arty_io review dependency is not identifiable

Problem
The pending checklist requires review against arty_io, but that identifier has no definition or link in this repository.

Why this matters
A future stabilizer cannot determine which consumer and requirements must be checked before completing this item.

Suggested fix
Use the canonical project/package name and add a reference or short identifying description.

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

Labels

agency-rocket Touched by a rocket skill

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant