ImmutableSortedDictionary<TKey,TValue>.Enumerator Struct

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Package:

System.Collections.Immutable v9.0.0-rc.2.24473.5

Source:

ImmutableSortedDictionary_2.Enumerator.cs

Enumerates the contents of a binary tree.

NuGet package: System.Collections.Immutable (about immutable collections and how to install)

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

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

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

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

Type Parameters

TKey

TValue

Inheritance

Object

ValueType

ImmutableSortedDictionary<TKey,TValue>.Enumerator

Implements

IEnumerator<KeyValuePair<TKey,TValue>> IEnumerator IDisposable

Remarks

This structure should be kept synchronized with the other two binary tree enumerators: System.Collections.Immutable.ImmutableList<T>.Enumerator and System.Collections.Immutable.ImmutableSortedSet<T>.Enumerator.

Caution

When this enumerator is used as a value type (that is, when it isn't boxed), do not copy it by assigning it to a second variable or by passing it to another method. When this enumerator is disposed of, it returns a mutable reference type stack to a resource pool, and if the value type enumerator is copied (which can easily happen unintentionally if you pass the value around), there is a risk that a stack that has already been returned to the resource pool may still be in use by one of the enumerator copies, leading to data corruption or exceptions.

Properties

Current

Gets the element at the current position of the enumerator.

Methods

Dispose()	Releases the resources used by the current instance of the ImmutableSortedDictionary<TKey,TValue>.Enumerator class.
MoveNext()	Advances the enumerator to the next element of the immutable sorted dictionary.
Reset()	Sets the enumerator to its initial position, which is before the first element in the immutable sorted dictionary.

Explicit Interface Implementations

IEnumerator.Current

The current element.

Thread Safety

This type is thread safe.