IEnumerator<T> Interfaccia

Definizione

Supporta un'iterazione semplice su una raccolta generica.

public interface IEnumerator<out T> : IDisposable, System.Collections.IEnumerator
public interface IEnumerator<T> : IDisposable, System.Collections.IEnumerator

Parametri di tipo

T

Tipo di oggetti da enumerare.

Questo parametro di tipo è covariante, ovvero puoi usare il tipo specificato o qualsiasi tipo più derivato. Per altre informazioni sulla covarianza e la controvarianza, vedi Covarianza e controvarianza nei generics.
Derivato
Implementazioni

Esempio

Nell'esempio seguente viene illustrata un'implementazione dell'interfaccia IEnumerator<T> per una classe di raccolta di oggetti personalizzati. L'oggetto personalizzato è un'istanza del tipo Boxe la classe di raccolta è BoxCollection. Questo esempio di codice fa parte di un esempio più ampio fornito per l'interfaccia ICollection<T>.


// Defines the enumerator for the Boxes collection.
// (Some prefer this class nested in the collection class.)
public class BoxEnumerator : IEnumerator<Box>
{
    private BoxCollection _collection;
    private int curIndex;
    private Box curBox;

    public BoxEnumerator(BoxCollection collection)
    {
        _collection = collection;
        curIndex = -1;
        curBox = default(Box);
    }

    public bool MoveNext()
    {
        //Avoids going beyond the end of the collection.
        if (++curIndex >= _collection.Count)
        {
            return false;
        }
        else
        {
            // Set current box to next item in collection.
            curBox = _collection[curIndex];
        }
        return true;
    }

    public void Reset() { curIndex = -1; }

    void IDisposable.Dispose() { }

    public Box Current
    {
        get { return curBox; }
    }

    object IEnumerator.Current
    {
        get { return Current; }
    }
}

Commenti

IEnumerator<T> è l'interfaccia di base per tutti gli enumeratori generici.

L'istruzione foreach del linguaggio C# (for each in C++, For Each in Visual Basic) nasconde la complessità degli enumeratori. Pertanto, è consigliabile usare foreach anziché modificare direttamente l'enumeratore.

Gli enumeratori possono essere usati per leggere i dati nella raccolta, ma non possono essere usati per modificare la raccolta sottostante.

Inizialmente, l'enumeratore viene posizionato prima del primo elemento della raccolta. In questa posizione, Current non è definito. Pertanto, è necessario chiamare MoveNext per far avanzare l'enumeratore al primo elemento della raccolta prima di leggere il valore di Current.

Current restituisce lo stesso oggetto finché non viene chiamato MoveNext. MoveNext imposta Current sull'elemento successivo.

Se MoveNext passa la fine della raccolta, l'enumeratore viene posizionato dopo l'ultimo elemento della raccolta e MoveNext restituisce false. Quando l'enumeratore si trova in questa posizione, le chiamate successive a MoveNext restituiscono anche false. Se l'ultima chiamata a MoveNext restituita false, Current non è definita. Non è possibile impostare di nuovo Current sul primo elemento della raccolta; è invece necessario creare una nuova istanza dell'enumeratore.

Il metodo Reset viene fornito per l'interoperabilità COM. Non deve necessariamente essere implementata; In alternativa, l'implementatore può semplicemente generare un NotSupportedException. Tuttavia, se si sceglie di eseguire questa operazione, assicurarsi che nessun chiamante si basi sulla funzionalità di Reset.

Se vengono apportate modifiche alla raccolta, ad esempio l'aggiunta, la modifica o l'eliminazione di elementi, il comportamento dell'enumeratore non è definito.

L'enumeratore non ha accesso esclusivo alla raccolta; pertanto, l'enumerazione tramite una raccolta non è intrinsecamente una procedura thread-safe. Per garantire la thread safety durante l'enumerazione, è possibile bloccare la raccolta durante l'intera enumerazione. Per consentire l'accesso alla raccolta da parte di più thread per la lettura e la scrittura, è necessario implementare la propria sincronizzazione.

Le implementazioni predefinite delle raccolte nello spazio dei nomi System.Collections.Generic non vengono sincronizzate.

Note per gli implementatori

L'implementazione di questa interfaccia richiede l'implementazione dell'interfaccia IEnumerator non generica. I metodi MoveNext() e Reset() non dipendono da Te vengono visualizzati solo sull'interfaccia non generica. La proprietà Current viene visualizzata in entrambe le interfacce e presenta tipi restituiti diversi. Implementare la proprietà Current non generica come implementazione esplicita dell'interfaccia. Ciò consente a qualsiasi consumer dell'interfaccia non generica di utilizzare l'interfaccia generica.

Inoltre, IEnumerator<T> implementa IDisposable, che richiede di implementare il metodo Dispose(). In questo modo è possibile chiudere le connessioni al database o rilasciare handle di file o operazioni simili quando si usano altre risorse. Se non sono presenti risorse aggiuntive da eliminare, fornire un'implementazione Dispose() vuota.

Proprietà

Current

Ottiene l'elemento nella raccolta in corrispondenza della posizione corrente dell'enumeratore.

Metodi

Dispose()

Esegue attività definite dall'applicazione associate alla liberazione, al rilascio o alla reimpostazione di risorse non gestite.

(Ereditato da IDisposable)
MoveNext()

Sposta l'enumeratore all'elemento successivo della raccolta.

(Ereditato da IEnumerator)
Reset()

Imposta l'enumeratore sulla posizione iniziale, ovvero prima del primo elemento della raccolta.

(Ereditato da IEnumerator)

Si applica a

Prodotto Versioni
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Vedi anche