ChannelReader<T>.ReadAllAsync(CancellationToken) 方法

定义

命名空间:

System.Threading.Channels

程序集:

System.Threading.Channels.dll

Source:

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返回一次，不再有数据可供读取或将永远可供读取的数据。