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.

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

Jump to bottom

Analyzer: Prefer Memory overloads for Stream async Read/Write methods #3497

Merged
merged 14 commits into from
Apr 29, 2020
Merged

Analyzer: Prefer Memory overloads for Stream async Read/Write methods #3497

merged 14 commits into from
Apr 29, 2020

Conversation

carlossanlop
Copy link
Member

@carlossanlop carlossanlop commented Apr 14, 2020 •
edited
Loading

Contributes to dotnet/runtime#33790

Summary

If the user invokes any of these methods from an object that is or inherits from Stream:

ReadAsync(Byte[], Int32, Int32)
ReadAsync(Byte[], Int32, Int32, CancellationToken)
WriteAsync(Byte[], Int32, Int32)
WriteAsync(Byte[], Int32, Int32, CancellationToken)

We should suggest to instead use:
ReadAsync(Memory<Byte>, CancellationToken)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

All unit tests passed locally.

@carlossanlop carlossanlop requested a review from a team as a code owner April 14, 2020 01:31
@carlossanlop carlossanlop self-assigned this Apr 14, 2020
@carlossanlop carlossanlop force-pushed the PreferStreamAsyncMemoryOverloads branch from 1b95644 to 7e85824 Compare April 15, 2020 04:34
@carlossanlop carlossanlop force-pushed the PreferStreamAsyncMemoryOverloads branch from 92b2053 to 3369442 Compare April 27, 2020 21:29
mavasani
mavasani approved these changes Apr 28, 2020
View reviewed changes
Copy link
Contributor

@mavasani mavasani left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@carlossanlop
Copy link
Member Author

@buyaa-n @stephentoub @bartonjs can I get a sign off from you please, if everything looks good?

buyaa-n
buyaa-n approved these changes Apr 28, 2020
View reviewed changes
Copy link
Contributor

@buyaa-n buyaa-n left a comment

Choose a reason for hiding this comment

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

Small comment, looks good, thanks!

src/NetAnalyzers/Core/Microsoft.NetCore.Analyzers/Runtime/PreferStreamAsyncMemoryOverloads.cs Outdated Show resolved Hide resolved
@carlossanlop @buyaa-n
buyaa-n 's suggested comment fix
9a3bc64 
Co-Authored-By: buyaa-n <buyankhishig.namnan@microsoft.com>
@carlossanlop carlossanlop merged commit b09efe5 into dotnet:master Apr 29, 2020
@carlossanlop carlossanlop deleted the PreferStreamAsyncMemoryOverloads branch April 29, 2020 00:01
@carlossanlop carlossanlop mentioned this pull request May 5, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Evangelink Evangelink Evangelink left review comments

@buyaa-n buyaa-n buyaa-n approved these changes

@mavasani mavasani mavasani approved these changes

@pgovind pgovind pgovind approved these changes

@jeffhandley jeffhandley Awaiting requested review from jeffhandley

@sharwell sharwell Awaiting requested review from sharwell

@stephentoub stephentoub Awaiting requested review from stephentoub

@jozkee jozkee Awaiting requested review from jozkee

@bartonjs bartonjs Awaiting requested review from bartonjs

Assignees

@carlossanlop carlossanlop

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@carlossanlop @stephentoub @pgovind @mavasani @bartonjs @Evangelink @buyaa-n