ImmutableList<T>.Enumerator Structure

 

Enumerates the contents of a binary tree.

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

Namespace:   System.Collections.Immutable
Assembly:  System.Collections.Immutable (in System.Collections.Immutable.dll)

[EditorBrowsableAttribute(EditorBrowsableState.Advanced)]
public struct Enumerator : IEnumerator<T>, IEnumerator, IDisposable

NameDescription
System_CAPS_pubpropertyCurrent

Gets the element at the current position of the enumerator.

NameDescription
System_CAPS_pubmethodDispose()

Releases the resources used by the current instance of the ImmutableList<T>.Enumerator class.

System_CAPS_pubmethodEquals(Object)

(Inherited from ValueType.)

System_CAPS_pubmethodGetHashCode()

(Inherited from ValueType.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodMoveNext()

Advances enumeration to the next element of the immutable list.

System_CAPS_pubmethodReset()

Sets the enumerator to its initial position, which is before the first element in the immutable list.

System_CAPS_pubmethodToString()

(Inherited from ValueType.)

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

System_CAPS_cautionCaution

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.

This type is thread safe.

Return to top
Show: