PipeReader Class

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Package:

System.IO.Pipelines v8.0.0

Source:

PipeReader.cs

Defines a class that provides access to a read side of pipe.

public ref class PipeReader abstract

public abstract class PipeReader

type PipeReader = class

Public MustInherit Class PipeReader

Inheritance

Object

PipeReader

Constructors

PipeReader()

Initializes a new instance of the PipeReader class.

Methods

AdvanceTo(SequencePosition)	Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.
AdvanceTo(SequencePosition, SequencePosition)	Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.
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 buffer size and 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.