Repository navigation
docs(vendored): update bam_codec comments to reflect noodles#364 closure - #182
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #182 +/- ##
==========================================
- Coverage 85.65% 85.65% -0.01%
==========================================
Files 128 128
Lines 51983 52001 +18
==========================================
+ Hits 44526 44541 +15
- Misses 7457 7460 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (4)
📝 WalkthroughWalkthroughModule-level documentation updated in four files across two crate locations. Changes state the BAM codec is vendored from noodles-bam, note that the upstream encode-expose PR was closed, recommend 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
PR #364 (expose record codec encode/decode) was closed upstream — the maintainer recommended Reader::from(src) for decoding instead. Update vendored module docs to remove #364 from the pending-PR list and explain why the vendored bam_codec is retained: encode_record_buf is still needed for the raw-byte-mode optimization path.
nh13
force-pushed
the
nh/docs-vendored-codec-phase1
branch
from
March 23, 2026 20:14
45201e8 to
6ae4650
Compare
Merged
nh13
added a commit
that referenced
this pull request
Mar 23, 2026
Replace the vendored bam_codec::decode with noodles' public Reader::from(src).read_record_buf() API, as recommended by the noodles maintainer when closing PR #364. The vendored decoder was only used in the non-raw-byte-mode path of decode_records(), which is not exercised by any production command (all use raw_byte_mode=true). Removing it eliminates 20 vendored files (~1850 lines) that would need to be diffed on every noodles version bump. The vendored encoder (encode_record_buf) is retained — it provides ~30% CPU savings in the raw-byte-mode write path and has no upstream equivalent until noodles#367 lands. Follows up on #182.
3 of 4 tasks
nh13
added a commit
that referenced
this pull request
Mar 23, 2026
Replace the vendored bam_codec::decode with noodles' public Reader::from(src).read_record_buf() API, as recommended by the noodles maintainer when closing PR #364. The vendored decoder was only used in the non-raw-byte-mode path of decode_records(), which is not exercised by any production command (all use raw_byte_mode=true). Removing it eliminates 20 vendored files (~1850 lines) that would need to be diffed on every noodles version bump. The vendored encoder (encode_record_buf) is retained — it provides ~30% CPU savings in the raw-byte-mode write path and has no upstream equivalent until noodles#367 lands. Follows up on #182.
nh13
added a commit
that referenced
this pull request
Mar 23, 2026
Replace the vendored bam_codec::decode with noodles' public Reader::from(src).read_record_buf() API, as recommended by the noodles maintainer when closing PR #364. The vendored decoder was only used in the non-raw-byte-mode path of decode_records(), which is not exercised by any production command (all use raw_byte_mode=true). Removing it eliminates 20 vendored files (~1850 lines) that would need to be diffed on every noodles version bump. The vendored encoder (encode_record_buf) is retained — it provides ~30% CPU savings in the raw-byte-mode write path and has no upstream equivalent until noodles#367 lands. Follows up on #182.
nh13
added a commit
that referenced
this pull request
Mar 24, 2026
Replace the vendored bam_codec::decode with noodles' public Reader::from(src).read_record_buf() API, as recommended by the noodles maintainer when closing PR #364. The vendored decoder was only used in the non-raw-byte-mode path of decode_records(), which is not exercised by any production command (all use raw_byte_mode=true). Removing it eliminates 20 vendored files (~1850 lines) that would need to be diffed on every noodles version bump. The vendored encoder (encode_record_buf) is retained — it provides ~30% CPU savings in the raw-byte-mode write path and has no upstream equivalent until noodles#367 lands. Follows up on #182.
nh13
added a commit
that referenced
this pull request
Mar 24, 2026
…PI (#185) Replace the vendored bam_codec::decode with noodles' public Reader::from(src).read_record_buf() API, as recommended by the noodles maintainer when closing PR #364. The vendored decoder was only used in the non-raw-byte-mode path of decode_records(), which is not exercised by any production command (all use raw_byte_mode=true). Removing it eliminates 20 vendored files (~1850 lines) that would need to be diffed on every noodles version bump. The vendored encoder (encode_record_buf) is retained — it provides ~30% CPU savings in the raw-byte-mode write path and has no upstream equivalent until noodles#367 lands. Follows up on #182.
This branch was previously deployed
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
1 participant
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
encode_record_bufis still needed for the raw-byte-mode optimization pathRecordBufencoding) lands upstreamTest plan
cargo build --releasepasses