ChannelReader<T>.ReadAllAsync(CancellationToken) メソッド

定義

名前空間:

System.Threading.Channels

アセンブリ:

System.Threading.Channels.dll

ソース:

ChannelReader.cs

チャネルからのすべてのデータを読み取るための IAsyncEnumerable<T> を作成します。

public virtual System.Collections.Generic.IAsyncEnumerable<T> ReadAllAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAllAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'T>
override this.ReadAllAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'T>

Public Overridable Function ReadAllAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of T)

パラメーター

cancellationToken

CancellationToken

列挙型をキャンセルするために使用するキャンセル トークン。 データがすぐに読み取り可能な場合は、取り消しが要求された後でも、そのデータが生成される可能性があります。

戻り値

IAsyncEnumerable<T>

作成された非同期の列挙型。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

を返すtrue各MoveNextAsync()呼び出しでは、チャネルから次の項目が読み取られます。

MoveNextAsync() は、 false それ以上のデータが読み取り可能でなくなるか、 を返します。