Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
PipeReader Class
Definition
- Namespace:
- System.IO.Pipelines
- Assembly:
- System.IO.Pipelines.dll
- Package:
- System.IO.Pipelines v11.0.0-preview.5.26302.115
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines a class that provides access to a read side of pipe.
public ref class PipeReader abstractpublic abstract class PipeReadertype PipeReader = classPublic MustInherit Class PipeReader- Inheritance
-
PipeReader
Constructors
| Name | Description |
|---|---|
| PipeReader() |
Initializes a new instance of the PipeReader class. |
Methods
| Name | Description |
|---|---|
| AdvanceTo(SequencePosition, SequencePosition) |
Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined. |
| AdvanceTo(SequencePosition) |
Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed. |
| AsStream(Boolean) |
Returns a Stream representation of the PipeReader. |
| CancelPendingRead() |
Cancels the pending ReadAsync(CancellationToken) operation without causing it to throw and without completing the PipeReader. If there is no pending operation, this cancels the next operation. |
| Complete(Exception) |
Signals to the producer that the consumer is done reading. |
| CompleteAsync(Exception) |
Marks the current pipe reader instance as being complete, meaning no more data will be read from it. |
| CopyToAsync(PipeWriter, CancellationToken) |
Asynchronously reads the bytes from the PipeReader and writes them to the specified PipeWriter, using a specified cancellation token. |
| CopyToAsync(Stream, CancellationToken) |
Asynchronously reads the bytes from the PipeReader and writes them to the specified stream, using a specified cancellation token. |
| Create(ReadOnlySequence<Byte>) |
Creates a PipeReader wrapping the specified ReadOnlySequence<T>. |
| Create(Stream, StreamPipeReaderOptions) |
Creates a PipeReader wrapping the specified Stream. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnWriterCompleted(Action<Exception,Object>, Object) |
Obsolete.
Registers a callback that executes when the PipeWriter side of the pipe is completed. |
| ReadAsync(CancellationToken) |
Asynchronously reads a sequence of bytes from the current PipeReader. |
| ReadAtLeastAsync(Int32, CancellationToken) |
Asynchronously reads a sequence of bytes from the current PipeReader. |
| ReadAtLeastAsyncCore(Int32, CancellationToken) |
Asynchronously reads a sequence of bytes from the current PipeReader. |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| TryRead(ReadResult) |
Attempts to synchronously read data the PipeReader. |
Applies to
Feedback
Was this page helpful?