Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / C#

IEnumerator — a interface de enumerador não genérica

System.Collections.IEnumerator descreve um cursor para ler elementos sequencialmente. Expõe MoveNext(), um Current do tipo object e Reset(); não é uma coleção nem garante suporte de IDisposable.

Versão: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Sintaxe

public interface IEnumerator
{
    object Current { get; }
    bool MoveNext();
    void Reset();
}

System.Collections.IEnumerator descreve o estado de uma passagem por uma coleção. Em contrapartida, System.Collections.IEnumerable expõe GetEnumerator(), que devolve um cursor deste tipo. No código habitual, prefira foreach, que oculta a gestão manual do enumerador. A interface está disponível no .NET 10 e não requer funcionalidades da linguagem em pré-visualização.

Inicialmente, o cursor encontra-se antes do primeiro elemento. Chame MoveNext() e leia Current apenas quando o resultado for true. Um resultado false significa que chegou ao fim; as chamadas seguintes também devolvem false, a menos que o enumerador seja reposto. Current não está definido antes do primeiro avanço bem-sucedido nem após a conclusão — não presuma um valor ou uma exceção específicos.

Current é uma propriedade só de leitura do tipo object: para recuperar um tipo específico pode ser necessária uma conversão, e os valores de tipos de valor são boxed. O tipo genérico System.Collections.Generic.IEnumerator<T> expõe um Current do tipo T e herda tanto de IEnumerator como de IDisposable. O IEnumerator não genérico não herda de IDisposable; numa iteração manual, liberte o enumerador se o respetivo objeto implementar essa interface.

Reset() destina-se a repor a posição antes do primeiro elemento, mas pode lançar NotSupportedException; serve principalmente para interoperabilidade com COM. Para repetir uma passagem, obtenha normalmente um novo enumerador. Não presuma que as alterações à coleção durante a iteração são suportadas: podem invalidar o enumerador. A interface não fornece segurança entre threads nem operações para modificar a coleção.

Exemplos

using System;
using System.Collections;

internal static class Program
{
    private static void Main()
    {
        IEnumerable values = new string[] { "Ada", "Lin" };
        IEnumerator cursor = values.GetEnumerator();

        try
        {
            while (cursor.MoveNext())
            {
                string value = (string)cursor.Current;
                Console.WriteLine(value);
            }
        }
        finally
        {
            (cursor as IDisposable)?.Dispose();
        }
    }
}

Resultado

Ada
Lin

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes