Queue<T>.GetEnumerator Method

Definition

Возвращает перечислитель, служащий для прохода по коллекции Queue<T>.Returns an enumerator that iterates through the Queue<T>.

public:
 System::Collections::Generic::Queue<T>::Enumerator GetEnumerator();
public System.Collections.Generic.Queue<T>.Enumerator GetEnumerator ();
member this.GetEnumerator : unit -> System.Collections.Generic.Queue<'T>.Enumerator
Public Function GetEnumerator () As Queue(Of T).Enumerator

Returns

Queue<T>.Enumerator

Объект Queue<T>.Enumerator для коллекции Queue<T>.An Queue<T>.Enumerator for the Queue<T>.

Examples

В следующем примере кода показано, что Queue<T> универсальный класс является перечислимым.The following code example demonstrates that the Queue<T> generic class is enumerable. Для перечисления очереди используется инструкция foreach (For Each в Visual Basic C++, for each в).The foreach statement (For Each in Visual Basic, for each in C++) is used to enumerate the queue.

В примере кода создается очередь строк с емкостью по умолчанию и используется метод Enqueue для постановки пяти строк в очередь.The code example creates a queue of strings with default capacity and uses the Enqueue method to queue five strings. Элементы очереди перечисляются, что не приводит к изменению состояния очереди.The elements of the queue are enumerated, which does not change the state of the queue. Метод Dequeue используется для вывода первой строки из очереди.The Dequeue method is used to dequeue the first string. Метод Peek используется для просмотра следующего элемента в очереди, а затем метод Dequeue используется для их вывода из очереди.The Peek method is used to look at the next item in the queue, and then the Dequeue method is used to dequeue it.

Метод ToArray используется для создания массива и копирования в него элементов очереди, затем массив передается конструктору Queue<T>, который принимает IEnumerable<T>, создавая копию очереди.The ToArray method is used to create an array and copy the queue elements to it, then the array is passed to the Queue<T> constructor that takes IEnumerable<T>, creating a copy of the queue. Отобразятся элементы копии.The elements of the copy are displayed.

Массив в два раза создается размер очереди, а метод CopyTo используется для копирования элементов массива, начиная с середины массива.An array twice the size of the queue is created, and the CopyTo method is used to copy the array elements beginning at the middle of the array. Конструктор Queue<T> снова используется для создания второй копии очереди, содержащей три элемента null в начале.The Queue<T> constructor is used again to create a second copy of the queue containing three null elements at the beginning.

Метод Contains позволяет показать, что строка «четыре» находится в первой копии очереди, после чего метод Clear очищает копию, а свойство Count показывает, что очередь пуста.The Contains method is used to show that the string "four" is in the first copy of the queue, after which the Clear method clears the copy and the Count property shows that the queue is empty.

using System;
using System.Collections.Generic;

class Example
{
    public static void Main()
    {
        Queue<string> numbers = new Queue<string>();
        numbers.Enqueue("one");
        numbers.Enqueue("two");
        numbers.Enqueue("three");
        numbers.Enqueue("four");
        numbers.Enqueue("five");

        // A queue can be enumerated without disturbing its contents.
        foreach( string number in numbers )
        {
            Console.WriteLine(number);
        }

        Console.WriteLine("\nDequeuing '{0}'", numbers.Dequeue());
        Console.WriteLine("Peek at next item to dequeue: {0}",
            numbers.Peek());
        Console.WriteLine("Dequeuing '{0}'", numbers.Dequeue());

        // Create a copy of the queue, using the ToArray method and the
        // constructor that accepts an IEnumerable<T>.
        Queue<string> queueCopy = new Queue<string>(numbers.ToArray());

        Console.WriteLine("\nContents of the first copy:");
        foreach( string number in queueCopy )
        {
            Console.WriteLine(number);
        }

        // Create an array twice the size of the queue and copy the
        // elements of the queue, starting at the middle of the
        // array.
        string[] array2 = new string[numbers.Count * 2];
        numbers.CopyTo(array2, numbers.Count);

        // Create a second queue, using the constructor that accepts an
        // IEnumerable(Of T).
        Queue<string> queueCopy2 = new Queue<string>(array2);

        Console.WriteLine("\nContents of the second copy, with duplicates and nulls:");
        foreach( string number in queueCopy2 )
        {
            Console.WriteLine(number);
        }

        Console.WriteLine("\nqueueCopy.Contains(\"four\") = {0}",
            queueCopy.Contains("four"));

        Console.WriteLine("\nqueueCopy.Clear()");
        queueCopy.Clear();
        Console.WriteLine("\nqueueCopy.Count = {0}", queueCopy.Count);
    }
}

/* This code example produces the following output:

one
two
three
four
five

Dequeuing 'one'
Peek at next item to dequeue: two
Dequeuing 'two'

Contents of the copy:
three
four
five

Contents of the second copy, with duplicates and nulls:



three
four
five

queueCopy.Contains("four") = True

queueCopy.Clear()

queueCopy.Count = 0
 */
Imports System.Collections.Generic

Module Example

    Sub Main

        Dim numbers As New Queue(Of String)
        numbers.Enqueue("one")
        numbers.Enqueue("two")
        numbers.Enqueue("three")
        numbers.Enqueue("four")
        numbers.Enqueue("five")

        ' A queue can be enumerated without disturbing its contents.
        For Each number As String In numbers
            Console.WriteLine(number)
        Next

        Console.WriteLine(vbLf & "Dequeuing '{0}'", numbers.Dequeue())
        Console.WriteLine("Peek at next item to dequeue: {0}", _
            numbers.Peek())    
        Console.WriteLine("Dequeuing '{0}'", numbers.Dequeue())

        ' Create a copy of the queue, using the ToArray method and the
        ' constructor that accepts an IEnumerable(Of T).
        Dim queueCopy As New Queue(Of String)(numbers.ToArray())

        Console.WriteLine(vbLf & "Contents of the first copy:")
        For Each number As String In queueCopy
            Console.WriteLine(number)
        Next
        
        ' Create an array twice the size of the queue, compensating
        ' for the fact that Visual Basic allocates an extra array 
        ' element. Copy the elements of the queue, starting at the
        ' middle of the array. 
        Dim array2((numbers.Count * 2) - 1) As String
        numbers.CopyTo(array2, numbers.Count)
        
        ' Create a second queue, using the constructor that accepts an
        ' IEnumerable(Of T).
        Dim queueCopy2 As New Queue(Of String)(array2)

        Console.WriteLine(vbLf & _
            "Contents of the second copy, with duplicates and nulls:")
        For Each number As String In queueCopy2
            Console.WriteLine(number)
        Next

        Console.WriteLine(vbLf & "queueCopy.Contains(""four"") = {0}", _
            queueCopy.Contains("four"))

        Console.WriteLine(vbLf & "queueCopy.Clear()")
        queueCopy.Clear()
        Console.WriteLine(vbLf & "queueCopy.Count = {0}", _
            queueCopy.Count)
    End Sub
End Module

' This code example produces the following output:
'
'one
'two
'three
'four
'five
'
'Dequeuing 'one'
'Peek at next item to dequeue: two
'
'Dequeuing 'two'
'
'Contents of the copy:
'three
'four
'five
'
'Contents of the second copy, with duplicates and nulls:
'
'
'
'three
'four
'five
'
'queueCopy.Contains("four") = True
'
'queueCopy.Clear()
'
'queueCopy.Count = 0

Remarks

Оператор foreach C# языка (for each в C++For Each в Visual Basic) скрывает сложность перечислителей.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Поэтому рекомендуется вместо непосредственного использования перечислителя применять ключевое слово foreach.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Перечислители могут использоваться для чтения данных в коллекции, но не для ее изменения.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Изначально перечислитель располагается перед первым элементом коллекции.Initially, the enumerator is positioned before the first element in the collection. В этой позиции значение свойства Current не определено.At this position, Current is undefined. Поэтому необходимо вызвать метод MoveNext, чтобы переместить перечислитель к первому элементу коллекции до считывания значения свойства Current.Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current возвращает тот же объект, пока не будет вызван метод MoveNext.Current returns the same object until MoveNext is called. MoveNext задает Current в качестве значения для следующего элемента.MoveNext sets Current to the next element.

Если MoveNext передает конец коллекции, перечислитель размещается после последнего элемента в коллекции и MoveNext возвращает false.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Если перечислитель находится в этой позиции, последующие вызовы MoveNext также возвращают false.When the enumerator is at this position, subsequent calls to MoveNext also return false. Если последний вызов MoveNext вернул false, Current не определено.If the last call to MoveNext returned false, Current is undefined. Значение свойства Current не может быть повторно задано первому элементу коллекции; вместо этого следует создать новый экземпляр перечислителя.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

Перечислитель является допустимым до тех пор, пока коллекция остается неизменной.An enumerator remains valid as long as the collection remains unchanged. Если в коллекцию вносятся изменения, например добавление, изменение или удаление элементов, перечислитель становится необратимо недействительным, а следующий вызов MoveNext или IEnumerator.Reset вызывает исключение InvalidOperationException.If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to MoveNext or IEnumerator.Reset throws an InvalidOperationException.

У перечислителя нет эксклюзивного доступа к коллекции, поэтому перечисление коллекции не является потокобезопасной процедурой.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Чтобы гарантировать потокобезопасность, можно заблокировать коллекцию на время всего перечисления.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Чтобы разрешить доступ к коллекции из нескольких потоков для чтения и записи, необходимо реализовать собственную синхронизацию.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Реализации по умолчанию коллекций в System.Collections.Generic не синхронизированы.Default implementations of collections in System.Collections.Generic are not synchronized.

Этот метод является операцией O (1).This method is an O(1) operation.

Applies to

See also