// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the Apache 2.0 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
{
///
/// Returns the first element of an 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 first element in the async-enumerable sequence.
/// is null.
/// (Asynchronous) The source sequence is empty.
public static ValueTask FirstAsync(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)
{
var first = await TryGetFirst(source, cancellationToken).ConfigureAwait(false);
return first.HasValue ? first.Value : throw Error.NoElements();
}
}
///
/// Returns the first element of an async-enumerable sequence that satisfies the condition in the predicate.
///
/// 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 first 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- The source sequence is empty.
public static ValueTask FirstAsync(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 first = await TryGetFirst(source, predicate, cancellationToken).ConfigureAwait(false);
return first.HasValue ? first.Value : throw Error.NoElements();
}
}
internal static ValueTask FirstAwaitAsyncCore(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 first = await TryGetFirst(source, predicate, cancellationToken).ConfigureAwait(false);
return first.HasValue ? first.Value : throw Error.NoElements();
}
}
#if !NO_DEEP_CANCELLATION
internal static ValueTask FirstAwaitWithCancellationAsyncCore(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 first = await TryGetFirst(source, predicate, cancellationToken).ConfigureAwait(false);
return first.HasValue ? first.Value : throw Error.NoElements();
}
}
#endif
}
}