IEnumerable<T>.GetEnumerator Methode

Definition

Namespace:

System.Collections.Generic

Assembly:

System.Runtime.dll

Gibt einen Enumerator zurück, der die Auflistung durchläuft.

C#

public System.Collections.Generic.IEnumerator<out T> GetEnumerator ();

Gibt zurück

IEnumerator<T>

Ein Enumerator, der zum Durchlaufen der Auflistung verwendet werden kann.

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie die IEnumerable<T> -Schnittstelle implementiert wird, und diese Implementierung wird verwendet, um eine LINQ-Abfrage zu erstellen. Wenn Sie implementierenIEnumerable<T>, müssen Sie auch implementieren IEnumerator<T> oder , nur für C#, können Sie den Yield-Schlüsselwort (keyword) verwenden. Die Implementierung IEnumerator<T> muss IDisposable ebenfalls implementiert werden, was In diesem Beispiel angezeigt wird.

C#

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Linq;

public class App
{
    // Exercise the Iterator and show that it's more
    // performant.
    public static void Main()
    {
        TestStreamReaderEnumerable();
        Console.WriteLine("---");
        TestReadingFile();
    }

    public static void TestStreamReaderEnumerable()
    {
        // Check the memory before the iterator is used.
        long memoryBefore = GC.GetTotalMemory(true);
      IEnumerable<String> stringsFound;
        // Open a file with the StreamReaderEnumerable and check for a string.
      try {
         stringsFound =
               from line in new StreamReaderEnumerable(@"c:\temp\tempFile.txt")
               where line.Contains("string to search for")
               select line;
         Console.WriteLine("Found: " + stringsFound.Count());
      }
      catch (FileNotFoundException) {
         Console.WriteLine(@"This example requires a file named C:\temp\tempFile.txt.");
         return;
      }

        // Check the memory after the iterator and output it to the console.
        long memoryAfter = GC.GetTotalMemory(false);
        Console.WriteLine("Memory Used With Iterator = \t"
            + string.Format(((memoryAfter - memoryBefore) / 1000).ToString(), "n") + "kb");
    }

    public static void TestReadingFile()
    {
        long memoryBefore = GC.GetTotalMemory(true);
      StreamReader sr;
      try {
         sr = File.OpenText("c:\\temp\\tempFile.txt");
      }
      catch (FileNotFoundException) {
         Console.WriteLine(@"This example requires a file named C:\temp\tempFile.txt.");
         return;
      }

        // Add the file contents to a generic list of strings.
        List<string> fileContents = new List<string>();
        while (!sr.EndOfStream) {
            fileContents.Add(sr.ReadLine());
        }

        // Check for the string.
        var stringsFound =
            from line in fileContents
            where line.Contains("string to search for")
            select line;

        sr.Close();
        Console.WriteLine("Found: " + stringsFound.Count());

        // Check the memory after when the iterator is not used, and output it to the console.
        long memoryAfter = GC.GetTotalMemory(false);
        Console.WriteLine("Memory Used Without Iterator = \t" +
            string.Format(((memoryAfter - memoryBefore) / 1000).ToString(), "n") + "kb");
    }
}

// A custom class that implements IEnumerable(T). When you implement IEnumerable(T),
// you must also implement IEnumerable and IEnumerator(T).
public class StreamReaderEnumerable : IEnumerable<string>
{
    private string _filePath;
    public StreamReaderEnumerable(string filePath)
    {
        _filePath = filePath;
    }

    // Must implement GetEnumerator, which returns a new StreamReaderEnumerator.
    public IEnumerator<string> GetEnumerator()
    {
        return new StreamReaderEnumerator(_filePath);
    }

    // Must also implement IEnumerable.GetEnumerator, but implement as a private method.
    private IEnumerator GetEnumerator1()
    {
        return this.GetEnumerator();
    }
    IEnumerator IEnumerable.GetEnumerator()
    {
        return GetEnumerator1();
    }
}

// When you implement IEnumerable(T), you must also implement IEnumerator(T),
// which will walk through the contents of the file one line at a time.
// Implementing IEnumerator(T) requires that you implement IEnumerator and IDisposable.
public class StreamReaderEnumerator : IEnumerator<string>
{
    private StreamReader _sr;
    public StreamReaderEnumerator(string filePath)
    {
        _sr = new StreamReader(filePath);
    }

    private string _current;
    // Implement the IEnumerator(T).Current publicly, but implement
    // IEnumerator.Current, which is also required, privately.
    public string Current
    {

        get
        {
            if (_sr == null || _current == null)
            {
                throw new InvalidOperationException();
            }

            return _current;
        }
    }

    private object Current1
    {

        get { return this.Current; }
    }

    object IEnumerator.Current
    {
        get { return Current1; }
    }

    // Implement MoveNext and Reset, which are required by IEnumerator.
    public bool MoveNext()
    {
        _current = _sr.ReadLine();
        if (_current == null)
            return false;
        return true;
    }

    public void Reset()
    {
        _sr.DiscardBufferedData();
        _sr.BaseStream.Seek(0, SeekOrigin.Begin);
        _current = null;
    }

    // Implement IDisposable, which is also implemented by IEnumerator(T).
    private bool disposedValue = false;
    public void Dispose()
    {
        Dispose(disposing: true);
        GC.SuppressFinalize(this);
    }

    protected virtual void Dispose(bool disposing)
    {
        if (!this.disposedValue)
        {
            if (disposing)
            {
                // Dispose of managed resources.
            }
            _current = null;
            if (_sr != null) {
               _sr.Close();
               _sr.Dispose();
            }
        }

        this.disposedValue = true;
    }

     ~StreamReaderEnumerator()
    {
        Dispose(disposing: false);
    }
}
// This example displays output similar to the following:
//       Found: 2
//       Memory Used With Iterator =     33kb
//       ---
//       Found: 2
//       Memory Used Without Iterator =  206kb

Hinweise

Das zurückgegebene IEnumerator<T> bietet die Möglichkeit, die Auflistung zu durchlaufen, indem eine Current -Eigenschaft verfügbar ist. Sie können Enumeratoren verwenden, um die Daten in einer Sammlung zu lesen, aber nicht, um die Auflistung zu ändern.

Zu Beginn wird der Enumerator vor das erste Element in der Auflistung positioniert. An dieser Position ist Current nicht definiert. Daher müssen Sie die MoveNext -Methode aufrufen, um den Enumerator auf das erste Element der Auflistung vor dem Lesen des Werts von Currentzu weiterentwickeln.

Current gibt dasselbe -Objekt zurück, bis MoveNext erneut als MoveNext auf das nächste Element festgelegt Current aufgerufen wird.

Wenn MoveNext das Ende der Auflistung übergibt, wird der Enumerator hinter dem letzten Element in der Auflistung platziert, und MoveNext gibt false zurück. Wenn sich der Enumerator an dieser Position befindet, geben nachfolgende Aufrufe von MoveNext auch false zurück. Wenn der letzte Aufruf MoveNext zurückgegebene false, Current ist nicht definiert. Sie können Current nicht erneut auf das erste Element der Auflistung festlegen, sondern müssen eine neue Enumeratorinstanz erstellen.

Wenn Änderungen an der Auflistung vorgenommen werden, z. B. das Hinzufügen, Ändern oder Löschen von Elementen, ist das Verhalten des Enumerators undefiniert.

Ein Enumerator hat keinen exklusiven Zugriff auf die Auflistung, sodass ein Enumerator gültig bleibt, solange die Auflistung unverändert bleibt. Wenn Änderungen an der Auflistung vorgenommen werden, z. B. das Hinzufügen, Ändern oder Löschen von Elementen, wird der Enumerator ungültig, und Sie erhalten möglicherweise unerwartete Ergebnisse. Außerdem ist das Aufzählen einer Sammlung keine threadsichere Prozedur. Um die Threadsicherheit zu gewährleisten, sollten Sie die Sammlung während des Enumerators sperren oder die Synchronisierung für die Sammlung implementieren.

Standardimplementierungen von Auflistungen im System.Collections.Generic Namespace werden nicht synchronisiert.

Gilt für:

Weitere Informationen

• IEnumerator<T>
• Exemplarische Vorgehensweise: Implementieren von IEnumerable(Of T) in Visual Basic
• Iteratoren (C#)
• Iteratoren (Visual Basic)