PipeReader.TryRead(ReadResult) Method

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Package:

System.IO.Pipelines v9.0.0-rc.2.24473.5

Source:

PipeReader.cs

Attempts to synchronously read data the PipeReader.

public:
 abstract bool TryRead([Runtime::InteropServices::Out] System::IO::Pipelines::ReadResult % result);

public abstract bool TryRead (out System.IO.Pipelines.ReadResult result);

abstract member TryRead : ReadResult -> bool

Public MustOverride Function TryRead (ByRef result As ReadResult) As Boolean

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

Boolean

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).