AsyncEnumerator 1.2.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package AsyncEnumerator --version 1.2.3
NuGet\Install-Package AsyncEnumerator -Version 1.2.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<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
#r "nuget: AsyncEnumerator, 1.2.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AsyncEnumerator as a Cake Addin
#addin nuget:?package=AsyncEnumerator&version=1.2.3

// Install AsyncEnumerator as a Cake Tool
#tool nuget:?package=AsyncEnumerator&version=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}");
 }
}

Product Compatible and additional computed target framework versions.
.NET Framework net is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages (43)

Showing the top 5 NuGet packages that depend on AsyncEnumerator:

Package Downloads
NBitcoin.Indexer

Library for querying data indexed by NBitcoin.Indexer on Azure Storage

Elect.Core

.Net Core Utilities methods

Carbon.Kit

Provides interfaces, abstractions and common functions which is the essence of Carbon Kit.

Libplanet.Net

A peer-to-peer networking layer based on Libplanet.

Halforbit.RecordStreams

Package Description

GitHub repositories (10)

Showing the top 5 popular GitHub repositories that depend on AsyncEnumerator:

Repository Stars
Flangvik/TeamFiltration
TeamFiltration is a cross-platform framework for enumerating, spraying, exfiltrating, and backdooring O365 AAD accounts
n00mkrad/text2image-gui
Somewhat modular text2image GUI, initially just for Stable Diffusion
RevoLand/Steam-Library-Manager
Open source utility to manage Steam, Origin and Uplay libraries in ease of use with multi library support. ||| Steam Games Database: https://stmstat.com
planetarium/libplanet
Blockchain in C#/.NET for on-chain, decentralized gaming
Texnomic/SecureDNS
Secure, Modern, Fully-Featured, All-In-One Cross-Architecture & Cross-Platform DNS Server Using .NET 7.0
Version Downloads Last updated
4.0.2 13,355,747 12/4/2019
4.0.1 158,765 10/22/2019
4.0.0 45,606 10/18/2019
3.1.0 126,275 9/23/2019
2.2.2 2,094,369 1/27/2019
2.2.1 1,427,538 5/29/2018
2.2.0 42,133 5/18/2018
2.1.1 688,054 1/20/2018
2.1.0 319,869 5/22/2017
2.0.1 56,143 2/13/2017
1.5.0 6,267 2/12/2017
1.4.2 3,892 2/6/2017
1.3.0 4,040 1/20/2017
1.2.3 9,376 1/6/2017
1.2.2 4,621 12/11/2016
1.2.1 3,078 12/10/2016
1.2.0 22,159 11/29/2016
1.1.3 3,234 11/28/2016
1.1.2 51,681 8/29/2016
1.0.3 6,444 4/28/2016

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.