Add classified blob reads - #1
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new blob-reading API that preserves bounded content and returns structured content classification, while keeping the existing Blob NUL-based binary detection semantics intact.
Changes:
- Introduces
InspectBlobandBlobResultfor bounded reads withmagic.Detect/magic.DetectPrefixclassification. - Refactors
Blobto share a commonreadBlobhelper while preserving its original behavior. - Updates package/docs and expands tests/benchmarks to cover classification, truncation, encodings, NUL handling, and error paths.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
test_helpers_test.go |
Generalizes git test helpers to testing.TB so they can be reused from benchmarks. |
README.md |
Documents InspectBlob and clarifies how it differs from the existing Blob behavior. |
go.sum |
Adds checksums for the new github.com/git-pkgs/magic dependency. |
go.mod |
Adds github.com/git-pkgs/magic v0.1.0 as a direct dependency. |
doc.go |
Updates package docstring to reflect blob content classification capability. |
blob.go |
Adds InspectBlob/BlobResult and refactors shared blob read logic into readBlob. |
blob_test.go |
Adds benchmarks and expands tests for InspectBlob classification and error reporting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Add
InspectBlobandBlobResultso callers can retain bounded blob content alongside amagic.Result. Complete reads useDetect, truncated reads useDetectPrefix, and the existingBlobAPI keeps its NUL-based behavior. Document the new API and cover text, prefix truncation, binary signatures, invalid UTF-8, UTF-16, NUL handling, empty blobs, and input errors.