Skip to content
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.

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

Remove _isBlocked constraint from StreamReader.Peek() #89609

Merged
merged 2 commits into from
Jul 29, 2023

Conversation

jozkee
Copy link
Member

@jozkee jozkee commented Jul 27, 2023

Fixes #68983

The bug was uncovered by the partial and zero-byte reads in DeflateStream breaking change i.e: the bug is not a regression.

@ghost
Copy link

ghost commented Jul 27, 2023

Tagging subscribers to this area: @dotnet/area-system-io
See info in area-owners.md if you want to be subscribed.

Issue Details

Fixes #68983

The bug was uncovered by the partial and zero-byte reads in DeflateStream breaking change i.e: the bug is not a regression.

Author: Jozkee
Assignees: -
Labels:

area-System.IO

Milestone: -

Comment on lines 6 to 44
public class ReadOneAtATimeStream : Stream
{
MemoryStream _memoryStream;

public ReadOneAtATimeStream(byte[] buffer)
{
_memoryStream = new MemoryStream(buffer);
}

public override bool CanRead => true;

public override bool CanSeek => false;

public override bool CanWrite => false;

public override long Length => _memoryStream.Length;

public override long Position
{
get => _memoryStream.Position;
set => throw new NotSupportedException();
}

public override int Read(byte[] buffer, int offset, int count)
{
if (count == 0 || Position == Length)
{
return 0;
}

_memoryStream.ReadExactly(buffer, offset, 1);
return 1;
}

public override void Flush() { }
public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException();
public override void SetLength(long value) => throw new NotSupportedException();
public override void Write(byte[] buffer, int offset, int count) => throw new NotSupportedException();
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you simplify this by just deriving from MemoryStream instead of Stream?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have a DelegateStream type in tests; it lets you just construct an instance, supplying the ctor with a delegate to use for various operations, so you might not even have to declare your own type. And if you do continue to have your own, assuming you derive from MemoryStream such that it can be really short, you could just make it a private nested class right next to the test that's using it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you simplify this by just deriving from MemoryStream instead of Stream?

I tried this first but realized that by overriding Read to call ReadExactly it would cause an infinite recursion loop.
I could achieve it if I call ReadByte but I thought that may break in the future if MemoryStream's ReadByte implementation changed to depend on Read, which is a pattern many Streams do.

Will change it to use the DelegateStream as suggested.

@jozkee jozkee merged commit 60c49c6 into dotnet:main Jul 29, 2023
@jozkee jozkee deleted the streamreader-peek branch July 29, 2023 02:21
@adamsitnik adamsitnik added this to the 8.0.0 milestone Jul 31, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Aug 30, 2023
@jozkee jozkee restored the streamreader-peek branch April 16, 2024 16:53
@jozkee jozkee deleted the streamreader-peek branch April 16, 2024 16:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

StreamReader.Peek() on a DeflateStream returns -1 early
3 participants