// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT License.
// See the LICENSE file in the project root for more information.
using System.Collections;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
namespace System.Linq
{
public static partial class AsyncEnumerable
{
#if INCLUDE_SYSTEM_LINQ_ASYNCENUMERABLE_DUPLICATES
// https://learn.microsoft.com/en-us/dotnet/api/system.linq.asyncenumerable.countasync?view=net-9.0-pp#system-linq-asyncenumerable-countasync-1(system-collections-generic-iasyncenumerable((-0))-system-threading-cancellationtoken)
///
/// Returns an async-enumerable sequence containing an that represents the total number of elements in an async-enumerable sequence.
///
/// The type of the elements in the source sequence.
/// An async-enumerable sequence that contains elements to be counted.
/// The optional cancellation token to be used for cancelling the sequence at any time.
/// An async-enumerable sequence containing a single element with the number of elements in the input sequence.
/// is null.
/// (Asynchronous) The number of elements in the source sequence is larger than .
/// The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior.
public static ValueTask CountAsync(this IAsyncEnumerable source, CancellationToken cancellationToken = default)
{
if (source == null)
throw Error.ArgumentNull(nameof(source));
return source switch
{
ICollection collection => new ValueTask(collection.Count),
IAsyncIListProvider listProv => listProv.GetCountAsync(onlyIfCheap: false, cancellationToken),
ICollection collection => new ValueTask(collection.Count),
_ => Core(source, cancellationToken),
};
static async ValueTask Core(IAsyncEnumerable source, CancellationToken cancellationToken)
{
var count = 0;
await foreach (var item in source.WithCancellation(cancellationToken).ConfigureAwait(false))
{
checked
{
count++;
}
}
return count;
}
}
// https://learn.microsoft.com/en-us/dotnet/api/system.linq.asyncenumerable.countasync?view=net-9.0-pp#system-linq-asyncenumerable-countasync-1(system-collections-generic-iasyncenumerable((-0))-system-func((-0-system-boolean))-system-threading-cancellationtoken)
///
/// Returns an async-enumerable sequence containing an that represents how many elements in the specified async-enumerable sequence satisfy a condition.
///
/// The type of the elements in the source sequence.
/// An async-enumerable sequence that contains elements to be counted.
/// A function to test each element for a condition.
/// The optional cancellation token to be used for cancelling the sequence at any time.
/// An async-enumerable sequence containing a single element with a number that represents how many elements in the input sequence satisfy the condition in the predicate function.
/// or is null.
/// The return type of this operator differs from the corresponding operator on IEnumerable in order to retain asynchronous behavior.
public static ValueTask CountAsync(this IAsyncEnumerable source, Func predicate, CancellationToken cancellationToken = default)
{
if (source == null)
throw Error.ArgumentNull(nameof(source));
if (predicate == null)
throw Error.ArgumentNull(nameof(predicate));
return Core(source, predicate, cancellationToken);
static async ValueTask Core(IAsyncEnumerable source, Func predicate, CancellationToken cancellationToken)
{
var count = 0;
await foreach (var item in source.WithCancellation(cancellationToken).ConfigureAwait(false))
{
if (predicate(item))
{
checked
{
count++;
}
}
}
return count;
}
}
#endif // INCLUDE_SYSTEM_LINQ_ASYNCENUMERABLE_DUPLICATES
// https://learn.microsoft.com/en-us/dotnet/api/system.linq.asyncenumerable.countasync?view=net-9.0-pp#system-linq-asyncenumerable-countasync-1(system-collections-generic-iasyncenumerable((-0))-system-func((-0-system-threading-cancellationtoken-system-threading-tasks-valuetask((system-boolean))))-system-threading-cancellationtoken)
// Two overloads here are replaced by a single method.
// System.Linq.AsyncEnumerable only supplies the async predicate form where the callback accepts a cancellation token, but
// the CountAwaitAsync version that does not take this does not add any additional functionality. Since developers will need
// to change their code in any case to move off these obsolete methods, it would not be particularly useful to add a
// non-cancellable async predicate overload in System.Interactive.Async.
///
/// Counts the elements in an async-enumerable sequence that satisfy a condition.
///
/// Type of elements in the source sequence.
/// A sequence of elements to count.
/// An asynchronous predicate to apply to each element in the source sequence.
/// An optional cancellation token for cancelling the sequence at any time.
/// A ValueTask containing the number of elements in the sequence that satisfy the predicate.
/// or is .
[GenerateAsyncOverload]
[Obsolete("Use CountAsync. IAsyncEnumerable LINQ is now in System.Linq.AsyncEnumerable, and the CountAwaitAsync functionality now exists as overloads of CountAsync.")]
private static ValueTask CountAwaitAsyncCore(this IAsyncEnumerable source, Func> predicate, CancellationToken cancellationToken = default)
{
if (source == null)
throw Error.ArgumentNull(nameof(source));
if (predicate == null)
throw Error.ArgumentNull(nameof(predicate));
return Core(source, predicate, cancellationToken);
static async ValueTask Core(IAsyncEnumerable source, Func> predicate, CancellationToken cancellationToken)
{
var count = 0;
await foreach (var item in source.WithCancellation(cancellationToken).ConfigureAwait(false))
{
if (await predicate(item).ConfigureAwait(false))
{
checked
{
count++;
}
}
}
return count;
}
}
#if !NO_DEEP_CANCELLATION
[Obsolete("Use CountAsync. IAsyncEnumerable LINQ is now in System.Linq.AsyncEnumerable, and the CountAwaitWithCancellationAsync functionality now exists as overloads of CountAsync.")]
[GenerateAsyncOverload]
private static ValueTask CountAwaitWithCancellationAsyncCore(this IAsyncEnumerable source, Func> predicate, CancellationToken cancellationToken = default)
{
if (source == null)
throw Error.ArgumentNull(nameof(source));
if (predicate == null)
throw Error.ArgumentNull(nameof(predicate));
return Core(source, predicate, cancellationToken);
static async ValueTask Core(IAsyncEnumerable source, Func> predicate, CancellationToken cancellationToken)
{
var count = 0;
await foreach (var item in source.WithCancellation(cancellationToken).ConfigureAwait(false))
{
if (await predicate(item, cancellationToken).ConfigureAwait(false))
{
checked
{
count++;
}
}
}
return count;
}
}
#endif
}
}