AsyncEnumerator 1.0.3

Introduces IAsyncEnumerable, IAsyncEnumerator, and ForEachAsync()
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.0.3
dotnet add package AsyncEnumerator --version 1.0.3
<PackageReference Include="AsyncEnumerator" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AsyncEnumerator --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

Add ForEachAsync overloaded method with item index as the second argument of a callback action

Dependencies

This package has no dependencies.

Showing the top 3 GitHub repositories that depend on AsyncEnumerator:

Repository Stars
dotnetcore/CAP
Distributed transaction solution in micro-service base on eventually consistency, also an eventbus with Outbox pattern
RevoLand/Steam-Library-Manager
Open source utility to manage Steam, Origin and Uplay libraries in ease of use with multi library support
planetarium/libplanet
Blockchain core in C#/.NET for persistent peer-to-peer online games

Version History

Version Downloads Last updated
3.1.0 4,314 9/23/2019
2.2.2 273,955 1/27/2019
2.2.1 398,389 5/29/2018
2.2.0 14,161 5/18/2018
2.1.1 82,155 1/20/2018
2.1.0 156,484 5/22/2017
2.0.1 43,150 2/13/2017
1.5.0 3,003 2/12/2017
1.4.2 1,022 2/6/2017
1.3.0 1,293 1/20/2017
1.2.3 6,338 1/6/2017
1.2.2 1,311 12/11/2016
1.2.1 373 12/10/2016
1.2.0 13,399 11/29/2016
1.1.3 392 11/28/2016
1.1.2 16,706 8/29/2016
1.0.3 1,862 4/28/2016
Show less