Class EmptyPipeReader

Namespace

IceRpc

Assembly

IceRpc.dll

Implements a stateless and therefore shareable PipeReader over an empty sequence.

public sealed class EmptyPipeReader : PipeReader

Inheritance

object

PipeReader

EmptyPipeReader

Inherited Members

PipeReader.AsStream(bool)

PipeReader.CompleteAsync(Exception)

PipeReader.CopyToAsync(PipeWriter, CancellationToken)

PipeReader.CopyToAsync(Stream, CancellationToken)

PipeReader.Create(ReadOnlySequence<byte>)

PipeReader.Create(Stream, StreamPipeReaderOptions)

PipeReader.OnWriterCompleted(Action<Exception, object>, object)

PipeReader.ReadAtLeastAsync(int, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PipeReaderExtensions.ToAsyncStream<T>(PipeReader, DecodeFunc<T>, ISliceProxy?, ISliceFeature?)

PipeReaderExtensions.ToAsyncStream<T>(PipeReader, DecodeFunc<T>, int, ISliceFeature?)

Remarks

Because this implementation is stateless, it does not implement CancelPendingRead correctly; in practice this discrepancy should not be noticeable.

Properties

Instance

Gets the shared instance of the empty pipe reader.

public static PipeReader Instance { get; }

Property Value

PipeReader

Methods

AdvanceTo(SequencePosition)

Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed.

public override void AdvanceTo(SequencePosition consumed)

Parameters

consumed SequencePosition

Marks the extent of the data that has been successfully processed.

AdvanceTo(SequencePosition, SequencePosition)

Moves forward the pipeline's read cursor to after the consumed data, marking the data as processed, read and examined.

public override void AdvanceTo(SequencePosition consumed, SequencePosition examined)

Parameters

consumed SequencePosition

Marks the extent of the data that has been successfully processed.

examined SequencePosition

Marks the extent of the data that has been read and examined.

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.

public override void CancelPendingRead()

Complete(Exception?)

Signals to the producer that the consumer is done reading.

public override void Complete(Exception? exception)

Parameters

exception Exception

Optional Exception indicating a failure that's causing the pipeline to complete.

ReadAsync(CancellationToken)

Asynchronously reads a sequence of bytes from the current PipeReader.

public override ValueTask<ReadResult> ReadAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is default.

Returns

ValueTask<ReadResult>

A ValueTask<TResult> representing the asynchronous read operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

TryRead(out ReadResult)

Attempts to synchronously read data the PipeReader.

public override bool TryRead(out ReadResult result)

Parameters

result ReadResult

When this method returns true, this value is set to a ReadResult instance that represents the result of the read call; otherwise, this value is set to default.

Returns

bool

true if data was available, or if the call was canceled or the writer was completed; otherwise, false.