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

以下示例演示自定义对象的集合类的接口实现 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; // 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 '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 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 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 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> 是所有泛型枚举器的基接口。

foreach C# For Each 语言 ( for each 的语句,Visual Basic) 隐藏枚举器的复杂性。 因此,建议使用 foreach ,而不是直接操作枚举数。

枚举器可用于读取集合中的数据,但不能用于修改基础集合。

最初,枚举数定位在集合中第一个元素的前面。 在此位置上,未定义 Current 。 因此,在读取 MoveNext 的值之前,必须调用 Current 将枚举器向前移动到集合的第一个元素。

在调用 Current 之前, MoveNext 返回相同的对象。 MoveNext Current 设置为下一个元素。

如果 MoveNext 传递集合的末尾,枚举器将定位在集合中的最后一个元素之后并 MoveNext 返回 false 。 当枚举器处于此位置时,后续调用 MoveNext 也会返回 false 。 如果返回 false 的最后一次调用 MoveNext Current 则为未定义。 无法再次将 Current 设置为集合的第一个元素;必须改为创建新的枚举器实例。

此方法 Reset 为 COM 互操作性提供。 它不一定需要实现;相反,实现者只需引发一个 NotSupportedException 。 但是,如果选择执行此操作,则应确保没有调用方依赖于该功能 Reset

如果对集合进行了更改,例如添加、修改或删除元素,则枚举器的行为是未定义的。

枚举数没有对集合的独占访问权;因此,从头到尾对一个集合进行枚举在本质上不是一个线程安全的过程。 若要确保枚举过程中的线程安全性,可以在整个枚举过程中锁定集合。 若要允许多个线程访问集合以进行读写操作,则必须实现自己的同步。

System.Collections.Generic 命名空间中集合的默认实现是不同步的。

实施者说明

实现此接口需要实现非泛型 IEnumerator 接口。 和 MoveNext() Reset() 方法不依赖于 T ,并且仅显示在非泛型接口上。 该 Current 属性同时显示在两个接口上,并且具有不同的返回类型。 将非泛型 Current 属性作为显式接口实现实现。 这允许非泛型接口的任何使用者使用泛型接口。

此外, IEnumerator<T> 实现 IDisposable 需要实现 Dispose() 该方法。 这使你可以在使用其他资源时关闭数据库连接或释放文件句柄或类似操作。 如果没有要释放的其他资源,请提供空 Dispose() 实现。