35 lines
1.2 KiB
C#
35 lines
1.2 KiB
C#
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
|
|
using System;
|
|
using System.Threading.Tasks;
|
|
using System.Threading;
|
|
|
|
namespace System.Collections.Generic
|
|
{
|
|
/// <summary>
|
|
/// Asynchronous version of the IEnumerator<T> interface, allowing elements to be
|
|
/// retrieved asynchronously.
|
|
/// </summary>
|
|
/// <typeparam name="T">Element type.</typeparam>
|
|
public interface IAsyncEnumerator<
|
|
#if !NO_VARIANCE
|
|
out
|
|
#endif
|
|
T> : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// Advances the enumerator to the next element in the sequence, returning the result asynchronously.
|
|
/// </summary>
|
|
/// <param name="cancellationToken">Cancellation token that can be used to cancel the operation.</param>
|
|
/// <returns>
|
|
/// Task containing the result of the operation: true if the enumerator was successfully advanced
|
|
/// to the next element; false if the enumerator has passed the end of the sequence.
|
|
/// </returns>
|
|
Task<bool> MoveNext(CancellationToken cancellationToken);
|
|
|
|
/// <summary>
|
|
/// Gets the current element in the iteration.
|
|
/// </summary>
|
|
T Current { get; }
|
|
}
|
|
}
|