IEnumerator<T> 介面

參考

定義

命名空間:: System.Collections.Generic

組件:: System.Runtime.dll

組件:: mscorlib.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

支援泛型集合上的簡單反覆專案。

generic <typename T>
public interface class IEnumerator : IDisposable, System::Collections::IEnumerator

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

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

類型參數

T

要列舉的物件類型。

這是共變數的型別參數。也就是說，您可以使用您指定的類型，或衍生程度較高的任何類型。如需共變數與反變數的詳細資訊，請參閱泛型中的共變數與反變數。

衍生: Microsoft.Extensions.Primitives.StringTokenizer.Enumerator

Microsoft.Extensions.Primitives.StringValues.Enumerator

Microsoft.VisualC.StlClr.DequeEnumerator<TValue>

Microsoft.VisualC.StlClr.HashEnumerator<TKey,TValue>

Microsoft.VisualC.StlClr.ListEnumerator<TValue>

更多…

實作: IEnumerator IDisposable

範例

下列範例示範自定義物件集合類別的 IEnumerator<T> 介面實作。自定義對像是類型 Box的實例，而集合類別 BoxCollection。此程式代碼範例是提供給 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; }
    }
}

' 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

備註

IEnumerator<T> 是所有泛型列舉值的基底介面。

C# 語言的 foreach 語句（C++ 中的for each，在 Visual Basic 中 For Each）會隱藏列舉值的複雜性。因此，建議使用 foreach，而不是直接操作列舉值。

列舉值可用來讀取集合中的數據，但無法用來修改基礎集合。

一開始，列舉值會放在集合中的第一個專案之前。在這個位置上，Current 未定義。因此，您必須先呼叫 MoveNext，才能將列舉值移至集合的第一個專案，然後再讀取 Current的值。

Current 會傳回相同的物件，直到呼叫 MoveNext 為止。 MoveNext 會將 Current 設定為下一個專案。

如果 MoveNext 傳遞集合結尾，則列舉值位於集合的最後一個項目之後，MoveNext 傳回 false。當列舉值位於這個位置時，後續呼叫 MoveNext 也會傳回 false。如果最後一次呼叫傳回 MoveNextfalse，則 Current 未定義。您無法再次將 Current 設定為集合的第一個專案;您必須改為建立新的列舉值實例。

Reset 方法提供 COM 互操作性。它不一定需要實作;相反地，實作者可以直接擲回 NotSupportedException。不過，如果您選擇這樣做，您應該確定沒有呼叫端依賴 Reset 功能。

如果對集合進行變更，例如新增、修改或刪除專案，列舉值的行為是未定義的。

列舉值沒有集合的獨佔存取權;因此，透過集合列舉本質上不是安全線程的程式。若要保證列舉期間的線程安全性，您可以在整個列舉期間鎖定集合。若要允許多個線程存取集合以進行讀取和寫入，您必須實作自己的同步處理。

System.Collections.Generic 命名空間中集合的預設實作不會同步處理。

給實施者的注意事項

實作此介面需要實作非泛型 IEnumerator 介面。 MoveNext() 和 Reset() 方法不相依於 T，而且只會出現在非泛型介面上。 Current 屬性會出現在介面上，而且有不同的傳回類型。將非泛型 Current 屬性實作為明確的介面實作。這可讓非泛型介面的任何取用者取用泛型介面。

此外，IEnumerator<T> 會實作 IDisposable，因此您必須實作 Dispose() 方法。這可讓您在使用其他資源時關閉資料庫連線或釋放檔句柄或類似作業。如果沒有其他資源可處置，請提供空 Dispose() 實作。

屬性

Current

取得集合中位於列舉值目前位置的專案。

方法

Dispose()	執行與釋放、釋放或重設非受控資源相關聯的應用程式定義工作。 (繼承來源 IDisposable)
MoveNext()	將列舉值前進至集合的下一個專案。 (繼承來源 IEnumerator)
Reset()	將列舉值設定為其初始位置，也就是集合中第一個專案之前。 (繼承來源 IEnumerator)

適用於

共用方式為

IEnumerator<T> 介面

定義

類型參數

範例

備註

給實施者的注意事項

屬性

方法

適用於

另請參閱

其他資源