docs(channel): clarify feature boundaries - #226
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Clarifies how Asyncband’s channel-related Cargo features map to the public API surface (by delivery family modules), and updates the crate-level API guide and changelog wording to match that framing.
Changes:
- Document that channel Cargo features align with the public modules
oneshot,mpsc, andbroadcast, with topology/capacity expressed in module paths and constructors. - Split the crate-level API guide’s “Send values” row into distinct oneshot/MPSC/broadcast entries for clearer boundaries.
- Adjust changelog wording around the removal of
broadcast::overflowvs. retention of thebroadcastfeature.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a channel-features clarification and tightens the MPSC description in the API table. |
| CHANGELOG.md | Updates wording about broadcast::overflow removal and the remaining broadcast feature. |
| asyncband/src/lib.rs | Expands crate docs to clarify feature boundaries and separates channel families in the API guide table. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
tisonkun
commented
Aug 27, 2026
tisonkun
commented
Aug 27, 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.
Summary
mpscCargo feature instead of introducing a speculativequeue,dispatch, orchannelaggregate.oneshot,mpsc, andbroadcast; topology and capacity remain API-level choices.broadcast::overflowwas removed, while thebroadcastfeature remains.Design Notes
Cargo features control compiled capabilities and dependencies; they do not need to encode every channel topology. The
broadcastfeature can expose specialized SPMC and MPMC APIs under one delivery family, while implementation-specific producer topology remains visible in module paths and types. Additional aggregate or leaf features should be introduced only when implemented variants demonstrate a material compile-time, dependency, binary-size, or audit boundary.Refs #167 and #206.
Validation:
cargo x check,cargo x build,cargo x lint,cargo x test, andcargo +1.86.0 check -p asyncband --no-default-features --features mpsc.