ImmutableSortedDictionary<TKey,TValue>.Enumerator Struct
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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))
- TKey
- TValue
- Inheritance
- Implements
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.
Current |
Gets the element at the current position of the enumerator. |
Dispose() |
Releases the resources used by the current instance of the ImmutableSortedDictionary<TKey,TValue>.Enumerator class. |
Move |
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. |
IEnumerator. |
The current element. |
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8 (package-provided), 8, 9 (package-provided), 9 |
.NET Framework | 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided) |
.NET Standard | 2.0 (package-provided) |
UWP | 10.0 |
This type is thread safe.
.NET feedback
.NET is an open source project. Select a link to provide feedback: