Sdílet prostřednictvím

IEnumerator<T> Rozhraní

Definice

Obor názvů:
System.Collections.Generic
Sestavení:
mscorlib.dll, System.Runtime.dll
Sestavení:
netstandard.dll, System.Runtime.dll
Sestavení:
System.Runtime.dll
Sestavení:
mscorlib.dll
Sestavení:
netstandard.dll
Zdroj:
IEnumerator.cs
Zdroj:
IEnumerator.cs

Podporuje jednoduchou iteraci v obecné kolekci.

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

Parametry typu

T

Typ objektů, které chcete vytvořit výčet.

Tento parametr typu je kovariantní. To znamená, že můžete použít buď zadaný typ, nebo libovolný typ, který je více odvozený. Další informace o kovarianci a kontravarianci najdete v tématu popisujícím kovarianci a kontravarianci u parametrického polymorfismu.
Odvozené
Implementuje
IEnumerator IDisposable

Příklady

Následující příklad ukazuje implementaci IEnumerator<T> rozhraní pro kolekci třídy vlastních objektů. Vlastní objekt je instance typu Boxa třída kolekce je BoxCollection. Tento příklad kódu je součástí většího příkladu zadaného ICollection<T> pro rozhraní.


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

Poznámky

IEnumerator<T> je základní rozhraní pro všechny obecné enumerátory.

Příkaz foreach jazyka C# (For Each v jazyce Visual Basic) skryje složitost výčtů. Proto se místo přímé manipulace s enumerátorem doporučuje použití foreach .

Enumerátory lze použít ke čtení dat v kolekci, ale nelze je použít k úpravě podkladové kolekce.

Na začátku je enumerátor umístěn před prvním prvkem v kolekci. V této pozici Current není definováno. Proto je nutné volat MoveNext , aby se enumerátor před čtením hodnoty Current.

Current vrátí stejný objekt, dokud MoveNext nebude volána. MoveNext nastaví Current na další prvek.

Pokud MoveNext předá konec kolekce, enumerátor je umístěn za posledním prvkem v kolekci a MoveNext vrátí .false Pokud je enumerátor na této pozici, následná volání vrátit MoveNext také false. Pokud se vrátí poslední volání MoveNextfalse, Current není definováno. Znovu nelze nastavit Current první prvek kolekce. Místo toho je nutné vytvořit novou instanci enumerátoru.

Metoda je poskytována Reset pro interoperabilitu modelu COM. Nemusí být nutně implementována; místo toho implementátor může jednoduše vyvolat NotSupportedException. Pokud se ale rozhodnete tuto akci provést, měli byste zajistit, aby se volající nespoléhali na Reset funkčnost.

Pokud jsou v kolekci provedeny změny, například přidání, úpravy nebo odstranění prvků, chování enumerátoru není definováno.

Enumerátor nemá výhradní přístup k kolekci; proto výčet prostřednictvím kolekce není vnitřně bezpečným postupem pro přístup z více vláken. Chcete-li zaručit bezpečnost vláken během výčtu, můžete kolekci uzamknout během celého výčtu. Pokud chcete povolit přístup ke kolekci více vlákny pro čtení a zápis, musíte implementovat vlastní synchronizaci.

Výchozí implementace kolekcí v System.Collections.Generic oboru názvů nejsou synchronizovány.

Poznámky pro implementátory

Implementace tohoto rozhraní vyžaduje implementaci negenerického IEnumerator rozhraní. Tyto MoveNext() a Reset() metody nezávisí na Ta zobrazují se pouze v negenerickém rozhraní. Vlastnost Current se zobrazí v obou rozhraních a má různé návratové typy. Implementujte negenerickou Current vlastnost jako explicitní implementaci rozhraní. To umožňuje jakémukoli příjemci negenerického rozhraní využívat obecné rozhraní.

Kromě toho IEnumerator<T> implementuje IDisposable, což vyžaduje, abyste implementovali metodu Dispose() . To vám umožní zavřít připojení k databázi nebo vydání souboru popisovačů nebo podobné operace při použití jiných prostředků. Pokud nejsou k dispozici žádné další prostředky, poskytněte prázdnou Dispose() implementaci.

Vlastnosti

Name Description
Current

Získá prvek v kolekci na aktuální pozici enumerátoru.

Metody

Name Description
Dispose()

Provádí úlohy definované aplikací související s uvolněním, uvolněním nebo resetováním nespravovaných prostředků.

(Zděděno od IDisposable)
MoveNext()

Přejde enumerátor na další prvek kolekce.

(Zděděno od IEnumerator)
Reset()

Nastaví enumerátor na počáteční pozici, která je před prvním prvkem v kolekci.

(Zděděno od IEnumerator)

Platí pro

Viz také