You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: xml/System.IO.Pipelines/PipeReader.xml
+26-2Lines changed: 26 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,19 @@ The memory for the consumed data will be released and no longer available. The <
85
85
<Docs>
86
86
<paramname="consumed">Marks the extent of the data that has been successfully processed.</param>
87
87
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.</summary>
88
-
<remarks>To be added.</remarks>
88
+
<remarks>
89
+
<formattype="text/markdown"><![CDATA[
90
+
91
+
## Remarks
92
+
93
+
The memory for the consumed data will be released and no longer available.
94
+
95
+
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.
96
+
97
+
The examined data communicates to the pipeline when it should signal more data is available.
98
+
99
+
]]></format>
100
+
</remarks>
89
101
</Docs>
90
102
</Member>
91
103
<MemberMemberName="AdvanceTo">
@@ -114,7 +126,19 @@ The memory for the consumed data will be released and no longer available. The <
114
126
<paramname="consumed">Marks the extent of the data that has been successfully processed.</param>
115
127
<paramname="examined">Marks the extent of the data that has been read and examined.</param>
116
128
<summary>Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.</summary>
117
-
<remarks>To be added.</remarks>
129
+
<remarks>
130
+
<formattype="text/markdown"><![CDATA[
131
+
132
+
## Remarks
133
+
134
+
The memory for the consumed data will be released and no longer available.
135
+
136
+
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.
137
+
138
+
The examined data communicates to the pipeline when it should signal more data is available.
0 commit comments