// 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.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.singleasync?view=net-9.0-pp#system-linq-asyncenumerable-singleasync-1(system-collections-generic-iasyncenumerable((-0))-system-threading-cancellationtoken)
///
/// Returns the only element of an async-enumerable sequence, and reports an exception if there is not exactly one element in the async-enumerable sequence.
///
/// The type of the elements in the source sequence.
/// Source async-enumerable sequence.
/// The optional cancellation token to be used for cancelling the sequence at any time.
/// ValueTask containing the single element in the async-enumerable sequence.
/// is null.
/// (Asynchronous) The source sequence contains more than one element. -or- The source sequence is empty.
public static ValueTask SingleAsync(this IAsyncEnumerable source, CancellationToken cancellationToken = default)
{
if (source == null)
throw Error.ArgumentNull(nameof(source));
return Core(source, cancellationToken);
static async ValueTask Core(IAsyncEnumerable source, CancellationToken cancellationToken)
{
if (source is IList list)
{
return list.Count switch
{
0 => throw Error.NoElements(),
1 => list[0],
_ => throw Error.MoreThanOneElement(),
};
}
await using var e = source.GetConfiguredAsyncEnumerator(cancellationToken, false);
if (!await e.MoveNextAsync())
{
throw Error.NoElements();
}
var result = e.Current;
if (await e.MoveNextAsync())
{
throw Error.MoreThanOneElement();
}
return result;
}
}
// https://learn.microsoft.com/en-us/dotnet/api/system.linq.asyncenumerable.singleasync?view=net-9.0-pp#system-linq-asyncenumerable-singleasync-1(system-collections-generic-iasyncenumerable((-0))-system-func((-0-system-boolean))-system-threading-cancellationtoken)
///
/// Returns the only element of an async-enumerable sequence that satisfies the condition in the predicate, and reports an exception if there is not exactly one element in the async-enumerable sequence.
///
/// The type of the elements in the source sequence.
/// Source async-enumerable sequence.
/// A predicate function to evaluate for elements in the source sequence.
/// The optional cancellation token to be used for cancelling the sequence at any time.
/// ValueTask containing the single element in the async-enumerable sequence that satisfies the condition in the predicate.
/// or is null.
/// (Asynchronous) No element satisfies the condition in the predicate. -or- More than one element satisfies the condition in the predicate. -or- The source sequence is empty.
public static ValueTask SingleAsync(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)
{
await using (var e = source.GetConfiguredAsyncEnumerator(cancellationToken, false))
{
while (await e.MoveNextAsync())
{
var result = e.Current;
if (predicate(result))
{
while (await e.MoveNextAsync())
{
if (predicate(e.Current))
{
throw Error.MoreThanOneElement();
}
}
return result;
}
}
}
throw Error.NoElements();
}
}
#endif // INCLUDE_SYSTEM_LINQ_ASYNCENUMERABLE_DUPLICATES
///
/// Returns the only element of an async-enumerable sequence that satisfies the condition in the asynchronous predicate, and reports an exception if there is not exactly one element in the async-enumerable sequence that matches the predicate.
///
/// The type of elements in the source sequence.
/// Source async-enumerable sequence.
/// An asynchronous predicate that will be applied to each element of the source sequence.
/// The optional cancellation token to be used for cancelling the sequence at any time.
/// ValueTask containing the only element in the async-enumerable sequence that satisfies the condition in the asynchronous predicate.
/// or is null.
/// (Asynchronous) No element satisfies the condition in the predicate. -or- More than one element satisfies the condition in the predicate. -or- The source sequence is empty.
[GenerateAsyncOverload]
[Obsolete("Use SingleAsync. IAsyncEnumerable LINQ is now in System.Linq.AsyncEnumerable, and the SingleAwaitAsync functionality now exists as overloads of SingleAsync.")]
private static ValueTask SingleAwaitAsyncCore(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)
{
await using (var e = source.GetConfiguredAsyncEnumerator(cancellationToken, false))
{
while (await e.MoveNextAsync())
{
var result = e.Current;
if (await predicate(result).ConfigureAwait(false))
{
while (await e.MoveNextAsync())
{
if (await predicate(e.Current).ConfigureAwait(false))
{
throw Error.MoreThanOneElement();
}
}
return result;
}
}
}
throw Error.NoElements();
}
}
#if !NO_DEEP_CANCELLATION
[GenerateAsyncOverload]
[Obsolete("Use SingleAsync. IAsyncEnumerable LINQ is now in System.Linq.AsyncEnumerable, and the SingleAwaitWithCancellationAsync functionality now exists as overloads of SingleAsync.")]
private static ValueTask SingleAwaitWithCancellationAsyncCore(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)
{
await using (var e = source.GetConfiguredAsyncEnumerator(cancellationToken, false))
{
while (await e.MoveNextAsync())
{
var result = e.Current;
if (await predicate(result, cancellationToken).ConfigureAwait(false))
{
while (await e.MoveNextAsync())
{
if (await predicate(e.Current, cancellationToken).ConfigureAwait(false))
{
throw Error.MoreThanOneElement();
}
}
return result;
}
}
}
throw Error.NoElements();
}
}
#endif
}
}