(Release) Buffer size consolidation#1165
Merged
adamhathcock merged 13 commits intoreleasefrom Jan 27, 2026
Merged
Conversation
adamhathcock
force-pushed
the
adam/buffer-size-consolidation
branch
from
294560d to
0a50386
Compare
This was referenced Jan 27, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request consolidates buffer size constants across the SharpCompress codebase by introducing a centralized Constants.BufferSize field (81920 bytes) and removing scattered magic numbers and previous constants. The PR also simplifies API signatures by removing the bufferSize parameter from archive detection methods across all factory classes and archive types.
Changes:
- Introduced
Constants.BufferSizeconstant to replace hardcoded buffer sizes and the removedReaderOptions.DefaultBufferSizeconstant - Removed
bufferSizeparameters fromIsArchive,IsZipFile, and related detection methods across the factory pattern and archive implementations - Updated all stream copy operations throughout the codebase to consistently use
Constants.BufferSize
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/SharpCompress/Common/Constants.cs | Introduces new Constants.BufferSize field (81920 bytes) as centralized buffer size constant |
| src/SharpCompress/Readers/ReaderOptions.cs | Removes DefaultBufferSize constant and updates BufferSize property to use Constants.BufferSize |
| src/SharpCompress/Utility.cs | Removes TEMP_BUFFER_SIZE constant and updates TransferTo, TransferToAsync, and SkipAsync methods to use Constants.BufferSize |
| src/SharpCompress/Factories/*.cs | Removes bufferSize parameter from IsArchive method signatures across all factory implementations |
| src/SharpCompress/Archives/Zip/ZipArchive.cs | Removes bufferSize parameter from IsZipFile and IsZipMulti public methods and updates internal calls |
| src/SharpCompress/Archives/ArchiveFactory.cs | Removes bufferSize parameter from public IsArchive methods |
| src/SharpCompress/Archives/Tar/TarArchive.cs | Updates stream copy operation to use Constants.BufferSize |
| src/SharpCompress/Archives/IArchiveEntryExtensions.cs | Removes local BufferSize constant and updates copy operations to use Constants.BufferSize |
| src/SharpCompress/Readers/AbstractReader.cs | Updates all CopyTo and CopyToAsync calls to use Constants.BufferSize |
| src/SharpCompress/Writers/Zip/ZipWriter.cs | Adds using alias for Constants and updates stream copy to use Constants.BufferSize |
| src/SharpCompress/Writers/GZip/GZipWriter.cs | Updates stream copy operation to use Constants.BufferSize |
| tests/SharpCompress.Test/Mocks/ForwardOnlyStream.cs | Updates constructor to use nullable buffer size parameter with Constants.BufferSize default |
| tests/SharpCompress.Test/packages.lock.json | Removes Mono.Posix.NETStandard package entries (unrelated to buffer size changes) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
@adamhathcock I've opened a new pull request, #1166, to work on those changes. Once the pull request is ready, I'll request review from you. |
Contributor
|
@adamhathcock I've opened a new pull request, #1167, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: adamhathcock <[email protected]>
Co-authored-by: adamhathcock <[email protected]>
Co-authored-by: adamhathcock <[email protected]>
Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize for backward compatibility
Fix grammatical errors in ArcFactory comment documentation
…ement minor versions
…into adam/buffer-size-consolidation
Contributor
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (21 files)
|
This was referenced Jan 28, 2026
This was referenced Feb 2, 2026
This was referenced Feb 11, 2026
Closed
This was referenced Feb 23, 2026
Closed
This was referenced Mar 2, 2026
Closed
This was referenced Mar 9, 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.
This pull request standardizes and centralizes the default buffer size used for stream operations across the codebase by introducing a new
Constants.BufferSizevalue. It also simplifies method signatures for archive detection by removing thebufferSizeparameter where possible, and updates all relevant usages to reference the new constant. These changes improve consistency, maintainability, and make it easier to change the buffer size globally in the future.Buffer Size Centralization and Usage Updates:
Constants.BufferSize(default 81920 bytes) insrc/SharpCompress/Common/Constants.cs, replacing scattered magic numbers and previous constants for buffer sizes throughout the codebase.IArchiveEntryExtensions.cs,TarArchive.cs,AbstractReader.cs) to useConstants.BufferSizeinstead of hardcoded values or previous constants. [1] [2] [3] [4]API Simplification and Consistency:
bufferSizeparameter fromIsArchiveand related methods in interfaces and factories (e.g.,IFactory,Factory, and all concrete factory classes), simplifying their signatures and usage. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]IsArchive,IsZipFile, and similar methods to match the new signatures, removing the buffer size argument and ensuring consistent use ofConstants.BufferSizeinternally. [1] [2] [3] [4]Legacy Constant Cleanup:
DefaultBufferSizeconstant fromReaderOptionsand updated its usage to referenceConstants.BufferSizeinstead. [1] [2]TEMP_BUFFER_SIZEinUtility.csandBufferSizeinIArchiveEntryExtensions.cs. [1] [2]