IEnumerator<T> Interfejs

Definicja

Obsługuje prostą iterację w kolekcji ogólnej.Supports a simple iteration over a generic collection.

generic <typename T>
public interface class IEnumerator : IDisposable, System::Collections::IEnumerator
public interface IEnumerator<out T> : IDisposable, System.Collections.IEnumerator
type IEnumerator<'T> = interface
    interface IDisposable
    interface IEnumerator
Public Interface IEnumerator(Of Out T)
Implements IDisposable, IEnumerator

Parametry typu

T

Typ obiektów do wyliczenia.The type of objects to enumerate.

Pochodne
Implementuje

Przykłady

W poniższym przykładzie przedstawiono implementację IEnumerator<T> interfejsu klasy kolekcji obiektów niestandardowych.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. Obiekt niestandardowy jest wystąpieniem typu Box, a Klasa kolekcji to. BoxCollectionThe custom object is an instance of the type Box, and the collection class is BoxCollection. Ten przykład kodu jest częścią większego przykładu dostarczonego dla ICollection<T> interfejsu.This code example is part of a larger example provided for the ICollection<T> interface.


// 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; }
    }

}
' Defines the enumerator for the Boxes collection.
' (Some prefer this class nested in the collection class.)
Public Class BoxEnumerator
    Implements IEnumerator(Of Box)
    Private _collection As BoxCollection
    Private curIndex As Integer
    Private curBox As Box


    Public Sub New(ByVal collection As BoxCollection)
        MyBase.New()
        _collection = collection
        curIndex = -1
        curBox = Nothing

    End Sub

    Private Property Box As Box
    Public Function MoveNext() As Boolean _
        Implements IEnumerator(Of Box).MoveNext
        curIndex = curIndex + 1
        If curIndex = _collection.Count Then
            ' Avoids going beyond the end of the collection.
            Return False
        Else
            'Set current box to next item in collection.
            curBox = _collection(curIndex)
        End If
        Return True
    End Function

    Public Sub Reset() _
        Implements IEnumerator(Of Box).Reset
        curIndex = -1
    End Sub

    Public Sub Dispose() _
        Implements IEnumerator(Of Box).Dispose

    End Sub

    Public ReadOnly Property Current() As Box _
        Implements IEnumerator(Of Box).Current

        Get
            If curBox Is Nothing Then
                Throw New InvalidOperationException()
            End If

            Return curBox
        End Get
    End Property

    Private ReadOnly Property Current1() As Object _
        Implements IEnumerator.Current

        Get
            Return Me.Current
        End Get
    End Property
End Class

' Defines two boxes as equal if they have the same dimensions.
Public Class BoxSameDimensions
    Inherits EqualityComparer(Of Box)

    Public Overrides Function Equals(ByVal b1 As Box, ByVal b2 As Box) As Boolean
        If b1.Height = b2.Height And b1.Length = b2.Length And b1.Width = b2.Width Then
            Return True
        Else
            Return False
        End If
    End Function

    Public Overrides Function GetHashCode(ByVal bx As Box) As Integer
        Dim hCode As Integer = bx.Height ^ bx.Length ^ bx.Width
        Return hCode.GetHashCode()
    End Function
End Class

Uwagi

IEnumerator<T>jest interfejsem podstawowym dla wszystkich ogólnych modułów wyliczających.IEnumerator<T> is the base interface for all generic enumerators.

foreach Instrukcja C# języka(for each C++w VisualBasic)ukrywazłożonośćmodułówwyliczających.For EachThe foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. W związku z foreach tym zaleca się użycie zamiast bezpośredniego manipulowania modułem wyliczającym.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Moduły wyliczające mogą służyć do odczytu danych w kolekcji, ale nie można za ich pomocą modyfikować kolekcji źródłowej.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Początkowo moduł wyliczający jest umieszczony przed pierwszym elementem w kolekcji.Initially, the enumerator is positioned before the first element in the collection. W tym miejscu Current nie jest zdefiniowane.At this position, Current is undefined. W związku z tym przed MoveNext przeczytaniem Currentwartości parametru należy wywołać metodę wyliczającą do pierwszego elementu kolekcji.Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Currentzwraca ten sam obiekt do MoveNext momentu wywołania metody.Current returns the same object until MoveNext is called. MoveNextustawia Current do następnego elementu.MoveNext sets Current to the next element.

Jeśli MoveNext przekazuje koniec kolekcji, moduł wyliczający jest umieszczony po ostatnim elemencie w kolekcji i MoveNext zwraca false.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Gdy moduł wyliczający znajduje się w tym miejscu, kolejne MoveNext wywołania również falsezwracają.When the enumerator is at this position, subsequent calls to MoveNext also return false. Jeśli ostatnie wywołanie MoveNext zwrócone false, Current nie jest zdefiniowane.If the last call to MoveNext returned false, Current is undefined. Nie można ponownie Current ustawić na pierwszy element kolekcji; zamiast tego należy utworzyć nowe wystąpienie modułu wyliczającego.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

Reset Metoda jest zapewniana dla współdziałania modelu com.The Reset method is provided for COM interoperability. Nie musi być zaimplementowana; Zamiast tego, implementacja może po prostu zgłosić NotSupportedException.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. Jeśli jednak zdecydujesz się to zrobić, upewnij się, że żadne obiekty wywołujące nie bazują na Reset tej funkcji.However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

Jeśli w kolekcji zostaną wprowadzone zmiany, takie jak dodawanie, modyfikowanie lub usuwanie elementów, zachowanie modułu wyliczającego jest niezdefiniowane.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

Moduł wyliczający nie ma wyłącznego dostępu do kolekcji, w związku z tym wyliczanie w kolekcji nie jest wewnętrznie procedurą odporną na wielowątkowość.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Aby zagwarantować bezpieczeństwo wątków podczas wyliczania, można zablokować kolekcję podczas całego procesu wyliczania.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Aby zezwolić wielu wątkom na dostęp do kolekcji w celu odczytu i zapisu danych, należy zaimplementować własny mechanizm synchronizacji.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Domyślne implementacje kolekcji w System.Collections.Generic przestrzeni nazw nie są zsynchronizowane.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Uwagi dotyczące implementowania

Implementacja tego interfejsu wymaga wdrożenia nieogólnego IEnumerator interfejsu.Implementing this interface requires implementing the nongeneric IEnumerator interface. Metody i nieReset() są zależne od ipojawiająsiętylkownieogólnyminterfejsie.T MoveNext()The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. Current Właściwość jest wyświetlana w obu interfejsie i ma różne typy zwracane.The Current property appears on both interfaces, and has different return types. Zaimplementuj nierodzajową Current właściwość jako jawną implementację interfejsu.Implement the nongeneric Current property as an explicit interface implementation. Pozwala to wszystkim konsumentom nieogólnego interfejsu na korzystanie z interfejsu ogólnego.This allows any consumer of the nongeneric interface to consume the generic interface.

Ponadto IEnumerator<T> Dispose() implementuje IDisposablemetodę, która wymaga zaimplementowania metody.In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. Pozwala to na zamknięcie połączeń z bazą danych lub wydań plików lub podobnych operacji przy korzystaniu z innych zasobów.This enables you to close database connections or release file handles or similar operations when using other resources. Jeśli nie ma dodatkowych zasobów do usunięcia, należy podać pustą Dispose() implementację.If there are no additional resources to dispose of, provide an empty Dispose() implementation.

Właściwości

Current

Pobiera element w kolekcji na bieżącym miejscu modułu wyliczającego.Gets the element in the collection at the current position of the enumerator.

Metody

Dispose()

Wykonuje zadania zdefiniowane przez aplikację skojarzone z uwalnianiem, zwalnianiem lub resetowaniem niezarządzanych zasobów.Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Odziedziczone po IDisposable)
MoveNext()

Przesuwa moduł wyliczający do następnego elementu kolekcji.Advances the enumerator to the next element of the collection.

(Odziedziczone po IEnumerator)
Reset()

Ustawia początkową pozycję modułu wyliczającego, która jest wcześniejsza niż pierwszy element w kolekcji.Sets the enumerator to its initial position, which is before the first element in the collection.

(Odziedziczone po IEnumerator)

Dotyczy

Zobacz też