HashSet<T>.Enumerator Structure

Enumerates the elements of a HashSet<T> object.

Namespace:  System.Collections.Generic
Assembly:  System.Core (in System.Core.dll)

Syntax

'Declaration
Public Structure Enumerator _
    Implements IEnumerator(Of T), IDisposable, IEnumerator
public struct Enumerator : IEnumerator<T>, 
    IDisposable, IEnumerator

The HashSet<T>.Enumerator generic type exposes the following members.

Properties

  Name Description
Public property Current Gets the element at the current position of the enumerator.

Top

Methods

  Name Description
Public method Dispose Releases all resources used by a HashSet<T>.Enumerator object.
Public method Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MoveNext Advances the enumerator to the next element of the HashSet<T> collection.
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate property IEnumerator.Current Gets the element at the current position of the enumerator.
Explicit interface implemetationPrivate method IEnumerator.Reset Sets the enumerator to its initial position, which is before the first element in the collection.

Top

Remarks

The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of enumerators. Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Initially, the enumerator is positioned before the first element in the collection. At this position, the Current property is undefined. Therefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current.

Current returns the same object until MoveNext is called. MoveNext sets Current to the next element.

If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. When the enumerator is at this position, subsequent calls to MoveNext also return false. If the last call to MoveNext returned false, Current is undefined. You cannot set Current to the first element of the collection again; you must create a new enumerator object instead.

An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined.

The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.