Skip to content

Document System.IO.Pipelines.PipeReader remarks #3685

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
merged 1 commit into from
Dec 19, 2019
Merged

Document System.IO.Pipelines.PipeReader remarks #3685

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 26 additions & 2 deletions xml/System.IO.Pipelines/PipeReader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,19 @@ The memory for the consumed data will be released and no longer available. The <
<Docs>
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The memory for the consumed data will be released and no longer available.

The <xref:System.IO.Pipelines.ReadResult.Buffer> previously returned from <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> must not be accessed after this call.

The examined data communicates to the pipeline when it should signal more data is available.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AdvanceTo">
Expand Down Expand Up @@ -114,7 +126,19 @@ The memory for the consumed data will be released and no longer available. The <
<param name="consumed">Marks the extent of the data that has been successfully processed.</param>
<param name="examined">Marks the extent of the data that has been read and examined.</param>
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The memory for the consumed data will be released and no longer available.

The <xref:System.IO.Pipelines.ReadResult.Buffer> previously returned from <xref:System.IO.Pipelines.PipeReader.ReadAsync(System.Threading.CancellationToken)> must not be accessed after this call.

The examined data communicates to the pipeline when it should signal more data is available.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AsStream">
Expand Down