Skip to content

Use Stream.ReadExactly on .NET 7 #535

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
Sergio0694 merged 2 commits into from
Dec 13, 2022
Merged

Use Stream.ReadExactly on .NET 7 #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f70ec2
Use Stream.ReadExactly on .NET 7
Sergio0694 Dec 13, 2022
cf451e8
Fix exception type from Stream.Read extension
Sergio0694 Dec 13, 2022
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
24 changes: 16 additions & 8 deletions src/CommunityToolkit.HighPerformance/Extensions/StreamExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,15 +198,21 @@ public static void Write(this Stream stream, ReadOnlySpan<byte> buffer)
/// <typeparam name="T">The type of value to read.</typeparam>
/// <param name="stream">The source <see cref="Stream"/> instance to read from.</param>
/// <returns>The <typeparamref name="T"/> value read from <paramref name="stream"/>.</returns>
/// <exception cref="InvalidOperationException">Thrown if <paramref name="stream"/> reaches the end.</exception>
/// <exception cref="EndOfStreamException">Thrown if <paramref name="stream"/> reaches the end.</exception>
#if NETSTANDARD2_1_OR_GREATER
[MethodImpl(MethodImplOptions.AggressiveInlining)]
#endif
public static unsafe T Read<T>(this Stream stream)
where T : unmanaged
{
#if NETSTANDARD2_1_OR_GREATER
T result = default;
#if NET7_0_OR_GREATER
T result;

stream.ReadExactly(new Span<byte>(&result, sizeof(T)));

return result;
#elif NETSTANDARD2_1_OR_GREATER
T result;
int bytesOffset = 0;

// As per Stream.Read's documentation:
Expand All @@ -220,7 +226,7 @@ public static unsafe T Read<T>(this Stream stream)
// A return value of 0 indicates that the end of the stream has been reached
if (bytesRead == 0)
{
ThrowInvalidOperationExceptionForEndOfStream();
ThrowEndOfStreamException();
}

bytesOffset += bytesRead;
Expand All @@ -240,7 +246,7 @@ public static unsafe T Read<T>(this Stream stream)

if (bytesRead == 0)
{
ThrowInvalidOperationExceptionForEndOfStream();
ThrowEndOfStreamException();
}

bytesOffset += bytesRead;
Expand Down Expand Up @@ -293,11 +299,13 @@ public static unsafe void Write<T>(this Stream stream, in T value)
#endif
}

#if !NET7_0_OR_GREATER
/// <summary>
/// Throws an <see cref="InvalidOperationException"/> when <see cref="Read{T}"/> fails.
/// Throws an <see cref="EndOfStreamException"/> when <see cref="Read{T}"/> fails.
/// </summary>
private static void ThrowInvalidOperationExceptionForEndOfStream()
private static void ThrowEndOfStreamException()
{
throw new InvalidOperationException("The stream didn't contain enough data to read the requested item.");
throw new EndOfStreamException("The stream didn't contain enough data to read the requested item.");
}
#endif
}
4 changes: 2 additions & 2 deletions tests/CommunityToolkit.HighPerformance.UnitTests/Extensions/Test_StreamExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public void Test_StreamExtensions_ReadWrite()
Assert.AreEqual(3.14f, stream.Read<float>());
Assert.AreEqual(unchecked(uint.MaxValue * 324823489204ul), stream.Read<ulong>());

_ = Assert.ThrowsException<InvalidOperationException>(() => stream.Read<long>());
_ = Assert.ThrowsException<EndOfStreamException>(() => stream.Read<long>());
}

// See https://github.com/CommunityToolkit/dotnet/issues/513
Expand All @@ -55,7 +55,7 @@ public void Test_StreamExtensions_ReadWrite_WithBufferedStream()
Assert.AreEqual(3.14f, stream.Read<float>());
Assert.AreEqual(unchecked(uint.MaxValue * 324823489204ul), stream.Read<ulong>());

_ = Assert.ThrowsException<InvalidOperationException>(() => stream.Read<long>());
_ = Assert.ThrowsException<EndOfStreamException>(() => stream.Read<long>());
}

private sealed class BufferedStream : MemoryStream
Expand Down