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

Provide System.IO.Pipelines package readme #94372

Conversation

eNeRGy164
Copy link
Contributor

Fill out details for the System.IO.Pipelines NuGet package readme.

See #92228

@ghost ghost added the community-contribution Indicates that the PR has been added by a community member label Nov 4, 2023
@ghost
Copy link

ghost commented Nov 4, 2023

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

Issue Details

Fill out details for the System.IO.Pipelines NuGet package readme.

See #92228

Author: eNeRGy164
Assignees: -
Labels:

area-System.IO

Milestone: -

Comment on lines +45 to +53
for (int i = 0; i < input.Length; i++)
{
Memory<byte> memory = writer.GetMemory(1);
memory.Span[0] = input[i];
writer.Advance(1);

// Make the data available to the PipeReader.
await writer.FlushAsync();
}
Copy link
Member

Choose a reason for hiding this comment

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

This example looks really inefficient.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried to create a simple implementation of the workings of Pipe but have no further experience with it in practice.

The example that is part of the conceptual documentation link (https://learn.microsoft.com/en-us/dotnet/standard/io/pipelines#pipe-basic-usage) requires quite a large explanation, which didn't seem appropriate for the readme of the package itself.

I'm open for suggestions.

Copy link
Member

Choose a reason for hiding this comment

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

cc @dotnet/area-system-io

@ViktorHofer ViktorHofer deleted the branch dotnet:PackageReadmesContinued January 22, 2024 18:04
@eNeRGy164 eNeRGy164 deleted the system-io-pipelines branch January 22, 2024 18:28
@eNeRGy164 eNeRGy164 restored the system-io-pipelines branch January 22, 2024 18:36
@github-actions github-actions bot locked and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.IO.Pipelines community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants