ImmutableList<T>.GetEnumerator Method

  • Reference

Definition

Namespace:
System.Collections.Immutable
Assembly:
System.Collections.Immutable.dll
Package:
System.Collections.Immutable v8.0.0
Package:
System.Collections.Immutable v9.0.0-rc.2.24473.5
Source:
ImmutableList_1.cs
Source:
ImmutableList_1.cs
Source:
ImmutableList_1.cs

Returns an enumerator that iterates through the immutable list.

public:
 virtual System::Collections::Immutable::ImmutableList<T>::Enumerator GetEnumerator();
public:
 System::Collections::Immutable::ImmutableList<T>::Enumerator GetEnumerator();
public System.Collections.Immutable.ImmutableList<T>.Enumerator GetEnumerator ();
abstract member GetEnumerator : unit -> System.Collections.Immutable.ImmutableList<'T>.Enumerator
override this.GetEnumerator : unit -> System.Collections.Immutable.ImmutableList<'T>.Enumerator
member this.GetEnumerator : unit -> System.Collections.Immutable.ImmutableList<'T>.Enumerator
Public Function GetEnumerator () As ImmutableList(Of T).Enumerator

Returns

ImmutableList<T>.Enumerator

An enumerator that can be used to iterate through the immutable list.

Remarks

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.

Applies to