Class PipeWriterExtensions

Namespace

ShapeShift

Assembly

ShapeShift.dll

Extension methods for PipeWriter.

public static class PipeWriterExtensions

Inheritance

object

PipeWriterExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

FlushAndThrowIfCanceledAsync(PipeWriter, CancellationToken)

Flushes a PipeWriter, translating a canceled flush into an OperationCanceledException.

public static ValueTask FlushAndThrowIfCanceledAsync(this PipeWriter writer, CancellationToken cancellationToken)

Parameters

writer PipeWriter

The writer to flush.

cancellationToken CancellationToken

The cancellation token to throw from, when the flush reports IsCanceled.

Returns

ValueTask

A task that represents the asynchronous flush operation.

Remarks

FlushAsync(CancellationToken) reports cancellation through the returned FlushResult rather than by throwing, which is easy to overlook. This method restores the more familiar throwing behavior expected of asynchronous APIs elsewhere in .NET.