IEnumerator<T> Arabirim

Tanım

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ür Parametreleri

Türetilmiş

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>

Diğer…

Uygulamalar

IEnumerator IDisposable

Örnekler

Aşağıdaki örnek, IEnumerator<T> bir özel nesneler koleksiyon sınıfı için arabirimin bir uygulamasını gösterir.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. Özel nesne, türünün bir örneğidir Box ve koleksiyon sınıfı olur BoxCollection .The custom object is an instance of the type Box, and the collection class is BoxCollection. Bu kod örneği, arabirim için sağlanmış daha büyük bir örneğin bir parçasıdır ICollection<T> .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

Açıklamalar

IEnumerator<T> Tüm genel Numaralandırıcılar için temel arabirimdir.IEnumerator<T> is the base interface for all generic enumerators.

foreachC# dilinin ( for each For Each Visual Basic içindeki C++) deyimleri, numaralandırıcıların karmaşıklığını gizler.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Bu nedenle, foreach Numaralandırıcının doğrudan düzenlenmesi yerine kullanılması önerilir.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Numaralandırıcılar, koleksiyonundaki verileri okumak için kullanılabilir, ancak temel koleksiyonu değiştirmek için kullanılamaz.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Başlangıçta, numaralandırıcı, koleksiyondaki ilk öğenin önüne yerleştirilir.Initially, the enumerator is positioned before the first element in the collection. Bu konumda Current tanımsız.At this position, Current is undefined. Bu nedenle, MoveNext değerini okumadan önce sayacı koleksiyonun ilk öğesine ilerletmek için çağrısı yapmanız gerekir Current .Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current çağrılana kadar aynı nesneyi döndürür MoveNext .Current returns the same object until MoveNext is called. MoveNext bir Current sonraki öğeye ayarlar.MoveNext sets Current to the next element.

MoveNextKoleksiyonun sonunu geçerse, Numaralandırıcı koleksiyondaki son öğeden sonra konumlandırılır ve MoveNext döndürür false .If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Numaralandırıcı bu konumda olduğunda, sonraki çağrılar MoveNext de döndürülür false .When the enumerator is at this position, subsequent calls to MoveNext also return false. Döndürülen son çağrı MoveNext false Current tanımsızdır.If the last call to MoveNext returned false, Current is undefined. CurrentKoleksiyonun ilk öğesine yeniden ayarlayamazsınız. bunun yerine yeni bir Numaralandırıcı örneği oluşturmanız gerekir.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

ResetYÖNTEMI com birlikte çalışabilirlik için verilmiştir.The Reset method is provided for COM interoperability. Uygulanması gerekmez; Bunun yerine uygulayıcısı yalnızca bir oluşturabilir NotSupportedException .It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. Ancak bunu yapmayı seçerseniz, hiçbir çağıranın işlevselliğe bağlı olmadığından emin olmanız gerekir Reset .However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

Koleksiyonda değişiklik yapılırsa (öğe ekleme, değiştirme veya silme gibi), Numaralandırıcının davranışı tanımsızdır.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

Numaralandırıcının, koleksiyona özel kullanım erişimi yok; bu nedenle, bir koleksiyon içinde numaralandırma aslında bir iş parçacığı açısından güvenli yordam değildir.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Numaralandırma sırasında iş parçacığı güvenliği sağlamak için tüm numaralandırma sırasında koleksiyonu kilitleyebilirsiniz.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Okuma ve yazma için birden çok iş parçacığı tarafından erişilecek koleksiyona izin vermek için kendi eşitlemenizi uygulamalısınız.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Ad alanındaki koleksiyonların varsayılan uygulamaları System.Collections.Generic eşitlenmez.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Uygulayanlara Notlar

Bu arabirimin uygulanması için genel olmayan arabirimin uygulanması gerekir IEnumerator .Implementing this interface requires implementing the nongeneric IEnumerator interface. MoveNext()Ve Reset() yöntemleri bağımlı değildir T ve yalnızca genel olmayan arabirimde görünür.The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. CurrentÖzelliği her iki arabirimde de görünür ve farklı dönüş türlerine sahiptir.The Current property appears on both interfaces, and has different return types. Genel olmayan Current özelliği açık arabirim uygulaması olarak uygulayın.Implement the nongeneric Current property as an explicit interface implementation. Bu, genel olmayan arabirimin tüm tüketicisinin genel arabirimi kullanmasına izin verir.This allows any consumer of the nongeneric interface to consume the generic interface.

Ayrıca, IEnumerator<T> yöntemini uygulamanızı IDisposable gerektiren öğesini uygular Dispose() .In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. Bu, diğer kaynakları kullanırken veritabanı bağlantılarını veya dosya tutamaçlarını veya benzer işlemleri kapatmanızı sağlar.This enables you to close database connections or release file handles or similar operations when using other resources. Atılırken ek kaynak yoksa boş bir Dispose() uygulama sağlayın.If there are no additional resources to dispose of, provide an empty Dispose() implementation.

Özellikler

Yöntemler

Şunlara uygulanır

Ayrıca bkz.

• IEnumerable<T>
• ICollection<T>
• System.Collections