Skip to content

Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize for backward compatibility #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamhathcock merged 3 commits into from
Jan 27, 2026
Merged

Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize for backward compatibility #1166

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
014bbc3
Initial plan
Copilot Jan 27, 2026
53f12d7
Add [Obsolete] attribute to ReaderOptions.DefaultBufferSize
Copilot Jan 27, 2026
010a38b
Add clarifying comment about buffer size value difference
Copilot Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/SharpCompress/Readers/ReaderOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ namespace SharpCompress.Readers;

public class ReaderOptions : OptionsBase
{
/// <summary>
/// The default buffer size for stream operations.
/// This value (65536 bytes) is preserved for backward compatibility.
/// New code should use Constants.BufferSize instead (81920 bytes), which matches .NET's Stream.CopyTo default.
/// </summary>
[Obsolete(
"Use Constants.BufferSize instead. This constant will be removed in a future version."
)]
public const int DefaultBufferSize = 0x10000;

/// <summary>
/// Look for RarArchive (Check for self-extracting archives or cases where RarArchive isn't at the start of the file)
/// </summary>
Expand Down