PipeReader.TryRead(ReadResult) Method

Definition

Attempts to synchronously read data the PipeReader.

public abstract bool TryRead(out System.IO.Pipelines.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

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

Remarks

If the pipe returns false, there is no need to call AdvanceTo(SequencePosition, SequencePosition).

Applies to

Продукт Версии
.NET 8 (package-provided), 9 (package-provided), 9, 10 (package-provided), 10
.NET Standard 2.0 (package-provided)