AsyncEnumerator 1.2.3

Introduces IAsyncEnumerable, IAsyncEnumerator, ForEachAsync(), and ParallelForEachAsync()
GitHub: https://github.com/tyrotoxin/AsyncEnumerable

PROBLEM SPACE

Helps to (a) create an element provider, where producing an element can take a lot of time
due to dependency on other asynchronous events (e.g. wait handles, network streams), and
(b) a consumer that processes those element as soon as they are ready without blocking
the thread (the processing is scheduled on a worker thread instead).


EXAMPLE

using System.Collections.Async;

static IAsyncEnumerable<int> ProduceAsyncNumbers(int start, int end)
{
 return new AsyncEnumerable<int>(async yield => {

   // Just to show that ReturnAsync can be used multiple times
   await yield.ReturnAsync(start);

   for (int number = start + 1; number <= end; number++)
     await yield.ReturnAsync(number);

   // You can break the enumeration loop with the following call:
   yield.Break();

   // This won't be executed due to the loop break above
   await yield.ReturnAsync(12345);
 });
}

// Just to compare with synchronous version of enumerator
static IEnumerable<int> ProduceNumbers(int start, int end)
{
 yield return start;

 for (int number = start + 1; number <= end; number++)
   yield return number;

 yield break;

 yield return 12345;
}

static async Task ConsumeNumbersAsync()
{
 var asyncEnumerableCollection = ProduceAsyncNumbers(start: 1, end: 10);
 await asyncEnumerableCollection.ForEachAsync(async number => {
   await Console.Out.WriteLineAsync($"{number}");
 });
}

// Just to compare with synchronous version of enumeration
static void ConsumeNumbers()
{
 // NOTE: IAsyncEnumerable is derived from IEnumerable, so you can use either
 var enumerableCollection = ProduceAsyncNumbers(start: 1, end: 10);
 //var enumerableCollection = ProduceNumbers(start: 1, end: 10);

 foreach (var number in enumerableCollection) {
   Console.Out.WriteLine($"{number}");
 }
}

There is a newer version of this package available.
See the version list below for details.
Install-Package AsyncEnumerator -Version 1.2.3
dotnet add package AsyncEnumerator --version 1.2.3
<PackageReference Include="AsyncEnumerator" Version="1.2.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AsyncEnumerator --version 1.2.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

1.2.3: AsyncEnumerationCanceledException is thrown to the async enumeration function when the AsyncEnumerator is disposed before reaching the end of enumeration, what allows to do the clean-up.
      Fixed MoveNextAsync() that threw an exception sometimes only when you passed the end of enumeration.
1.2.2: Fix exception propagation in AsyncEnumerator.
1.2.1: New Linq-style extension methods in System.Collections.Async namespace.
1.2.0: Contract breaking changes in ParallelForEachAsync: introduce ParallelForEachException to unify error outcome of the loop.
1.1.0: Add ParallelForEachAsync extension methods for IEnumerable<T> and IAsyncEnumerable<T> in System.Collections.Async namespace.

Dependencies

This package has no dependencies.

Version History

Version Downloads Last updated
3.0.2-beta 1,732 4/9/2019
3.0.0-beta1 2,814 2/23/2019
2.2.2 54,907 1/27/2019
2.2.1 308,327 5/29/2018
2.2.0 9,606 5/18/2018
2.1.1 66,130 1/20/2018
2.1.0 133,374 5/22/2017
2.0.1 40,416 2/13/2017
1.5.0 2,707 2/12/2017
1.4.2 946 2/6/2017
1.3.0 1,224 1/20/2017
1.2.3 6,249 1/6/2017
1.2.2 1,056 12/11/2016
1.2.1 298 12/10/2016
1.2.0 9,103 11/29/2016
1.1.3 310 11/28/2016
1.1.2 13,519 8/29/2016
1.0.3 1,611 4/28/2016
Show less