AsyncIterableStream<T>

public sealed class AsyncIterableStream<T> : IAsyncEnumerable<T>

A readable stream that can also be enumerated with await foreach.

Type parameters

Name	Description
`T`

Inheritance: object

Implements: IAsyncEnumerable<T>

Constructors

public AsyncIterableStream(ReadableStream<T> stream)

Creates an iterable view of <code class=“paramref”>stream</code>.

Parameters

Name	Type	Description
`stream`	`ReadableStream<T>`

public bool Locked { get; }

Whether a reader holds the lock.

Value: bool

public ReadableStream<T> Stream { get; }

Underlying stream.

Value: ReadableStream<T>

public Task CancelAsync()

Cancels the stream.

Returns: Task

public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken cancellationToken = default)

Returns an enumerator that iterates asynchronously through the collection.

Parameters

Name	Type	Description
`cancellationToken`	CancellationToken	A CancellationToken that may be used to cancel the asynchronous iteration.

Returns: IAsyncEnumerator<T> — An enumerator that can be used to iterate asynchronously through the collection.

public StreamIterator<T> GetIterator()

Starts an iterator that cancels the stream when exited early.

Returns: StreamIterator<T>

public ReadableStreamReader<T> GetReader()

Locks the stream.

Returns: ReadableStreamReader<T>

public Task<List<T>> ToArrayAsync()

Reads every value.

Returns: Task<List<T>>