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

Add DeserializeEnumerableAsync<T> methods for streaming sequences #241

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

AArnott
Copy link
Owner

@AArnott AArnott commented Jan 29, 2025

See #237

@AArnott AArnott added the enhancement New feature or request label Jan 29, 2025
@AArnott AArnott requested a review from Copilot January 29, 2025 17:11
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 13 changed files in this pull request and generated 1 comment.

Files not reviewed (8)
  • src/Nerdbank.MessagePack/MessagePackSerializer.AutomatedFriendlyOverloads.tt: Language not supported
  • src/Nerdbank.MessagePack/net8.0/PublicAPI.Unshipped.txt: Language not supported
  • src/Nerdbank.MessagePack/netstandard2.0/PublicAPI.Unshipped.txt: Language not supported
  • docfx/docs/features.md: Evaluated as low risk
  • docfx/docs/migrating.md: Evaluated as low risk
  • docfx/docs/streaming-deserialization.md: Evaluated as low risk
  • docfx/docs/toc.yml: Evaluated as low risk
  • samples/StreamingDeserialization.cs: Evaluated as low risk
Comments suppressed due to low confidence (4)

src/Nerdbank.MessagePack/MessagePackSerializer.cs:470

  • [nitpick] The XML documentation comments for the parameters 'reader', 'shape', and 'cancellationToken' are missing. Please add these comments for clarity.
public IAsyncEnumerable<T?> DeserializeEnumerableAsync<T>(PipeReader reader, ITypeShape<T> shape, CancellationToken cancellationToken = default)

src/Nerdbank.MessagePack/MessagePackSerializer.cs:475

  • [nitpick] The XML documentation comments for the parameters 'reader', 'provider', and 'cancellationToken' are missing. Please add these comments for clarity.
public IAsyncEnumerable<T?> DeserializeEnumerableAsync<T>(PipeReader reader, ITypeShapeProvider provider, CancellationToken cancellationToken = default)

test/Nerdbank.MessagePack.Tests/AsyncSerializationTests.cs:129

  • The test method DeserializeEnumerableAsync_Array is marked as skipped. Please implement this test or remove it if it's not needed.
[Fact(Skip = "Not ready")]

src/Nerdbank.MessagePack/MessagePackAsyncReader.cs:218

  • [nitpick] The method name 'GetIsEndOfStreamAsync' could be simplified to 'IsEndOfStreamAsync' for better readability.
internal async ValueTask<bool> GetIsEndOfStreamAsync()

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

Attention: Patch coverage is 78.12500% with 7 lines in your changes missing coverage. Please review.

Project coverage is 84.32%. Comparing base (997b760) to head (e5e693e).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...agePack/MessagePackSerializer.FriendlyOverloads.cs 0.00% 5 Missing ⚠️
src/Nerdbank.MessagePack/MessagePackSerializer.cs 90.00% 1 Missing ⚠️
...dbank.MessagePack.Tests/AsyncSerializationTests.cs 92.30% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #241      +/-   ##
==========================================
- Coverage   84.34%   84.32%   -0.02%     
==========================================
  Files         164      164              
  Lines       12907    12939      +32     
  Branches     1405     1410       +5     
==========================================
+ Hits        10886    10911      +25     
- Misses       1992     1999       +7     
  Partials       29       29              
Flag Coverage Δ
Linux 82.52% <78.12%> (-0.04%) ⬇️
Windows 84.31% <78.12%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@AArnott AArnott merged commit cf5b860 into main Jan 29, 2025
3 checks passed
@AArnott AArnott deleted the fix237 branch January 29, 2025 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant