Dictionary<TKey,TValue>.Enumerator Структура

Определение

Пространство имен:

System.Collections.Generic

Сборка:

System.Collections.dll

Исходный код:

Dictionary.cs

Выполняет перечисление элементов коллекции Dictionary<TKey,TValue>.

public: value class Dictionary<TKey, TValue>::Enumerator : System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<TKey, TValue>>, System::Collections::IDictionaryEnumerator

public struct Dictionary<TKey,TValue>.Enumerator : System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<TKey,TValue>>, System.Collections.IDictionaryEnumerator

type Dictionary<'Key, 'Value>.Enumerator = struct
    interface IEnumerator<KeyValuePair<'Key, 'Value>>
    interface IEnumerator
    interface IDisposable
    interface IDictionaryEnumerator

Public Structure Dictionary(Of TKey, TValue).Enumerator
Implements IDictionaryEnumerator, IEnumerator(Of KeyValuePair(Of TKey, TValue))

Параметры типа

TKey

TValue

Наследование

Object

ValueType

Dictionary<TKey,TValue>.Enumerator

Реализации

IEnumerator<KeyValuePair<TKey,TValue>> IDictionaryEnumerator IEnumerator IDisposable

Комментарии

Оператор foreach языка C# (for each в C++, For Each в Visual Basic) скрывает сложность перечислителей. Поэтому рекомендуется вместо непосредственного использования перечислителя применять ключевое слово foreach.

Перечислители могут использоваться для чтения данных в коллекции, но не для ее изменения.

Изначально перечислитель располагается перед первым элементом коллекции. В этой позиции значение свойства Current не определено. Необходимо вызвать метод MoveNext , чтобы перейти перечислитель к первому элементу коллекции, прежде чем считывать значение Current.

Current возвращает тот же объект, пока не будет вызван метод MoveNext. MoveNext задает Current в качестве значения для следующего элемента.

Если MoveNext передает конец коллекции, перечислитель размещается после последнего элемента в коллекции и MoveNext возвращает значение false. Если перечислитель находится в этой позиции, последующие вызовы также MoveNext возвращают .false Если последний вызов MoveNext возвращал false, Current значение не определено. Значение свойства Current не может быть повторно задано первому элементу коллекции; вместо этого следует создать новый экземпляр перечислителя.

Перечислитель является допустимым до тех пор, пока коллекция остается неизменной. Если в коллекцию вносятся изменения, такие как добавление элементов или изменение емкости, перечислитель становится безвозвратно недействительным и следующий вызов MoveNext или IEnumerator.Reset вызывает исключение InvalidOperationException.

Только для .NET Core 3.0 и более поздних версий. Единственными изменяющими методами, которые не делают перечислители недействительными, являются Remove и Clear.

У перечислителя нет эксклюзивного доступа к коллекции, поэтому перечисление коллекции не является потокобезопасной процедурой. Чтобы гарантировать потокобезопасность, можно заблокировать коллекцию на время всего перечисления. Чтобы разрешить доступ к коллекции из нескольких потоков для чтения и записи, необходимо реализовать собственную синхронизацию.

Реализации коллекций по умолчанию в System.Collections.Generic не синхронизируются.

Свойства

Current

Возвращает элемент, расположенный в текущей позиции перечислителя.

Методы

Dispose()	Освобождает все ресурсы, занятые модулем Dictionary<TKey,TValue>.Enumerator.
MoveNext()	Перемещает перечислитель к следующему элементу коллекции Dictionary<TKey,TValue>.

Явные реализации интерфейса

IDictionaryEnumerator.Entry	Возвращает элемент, расположенный в текущей позиции перечислителя.
IDictionaryEnumerator.Key	Возвращает ключ элемента, расположенного в текущей позиции перечислителя.
IDictionaryEnumerator.Value	Возвращает значение элемента, расположенного в текущей позиции перечислителя.
IEnumerator.Current	Возвращает элемент, расположенный в текущей позиции перечислителя.
IEnumerator.Reset()	Устанавливает перечислитель в его начальное положение, т. е. перед первым элементом коллекции.

См. также раздел

• Dictionary<TKey,TValue>.KeyCollection.Enumerator
• Dictionary<TKey,TValue>.ValueCollection.Enumerator
• IEnumerable<T>
• IEnumerator<T>