SequencedDictionary<TKey, TValue>.Enumerator Struct

Definition

Namespace

Bodu.Collections.Generic

Assembly

Bodu.Collections.dll

Package

Bodu.Collections 1.0.0

Source

SequencedDictionary{T,T}.DictionaryEnumerator.cs

Enumerates the entries of a SequencedDictionary<TKey, TValue> in iteration order without allocating.

public struct SequencedDictionary<TKey, TValue>.Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, IEnumerator, IDisposable

Implements

IEnumerator<KeyValuePair<TKey, TValue>>

IEnumerator

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.Clamp<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsBetween<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.IsGreaterThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsGreaterThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsOutside<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

Use the foreach statement to enumerate the dictionary rather than using this struct directly.

The enumerator captures the dictionary's version on construction. Any mutation of the dictionary (including reads that reposition entries in access-order mode) invalidates the enumerator and causes MoveNext() or Reset() to throw InvalidOperationException.

Properties

Current

Gets the element in the collection at the current position of the enumerator.

public readonly KeyValuePair<TKey, TValue> Current { get; }

Property Value

KeyValuePair<TKey, TValue>

The element in the collection at the current position of the enumerator.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public readonly void Dispose()

MoveNext()

Advances the enumerator to the next element of the collection.

public bool MoveNext()

Returns

bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

Reset()

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

public void Reset()

Remarks

Restarts the walk from the beginning against the version captured at construction.

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

NotSupportedException

The enumerator does not support being reset.

Explicit Interface Implementations

IEnumerator.Current

Gets the element in the collection at the current position of the enumerator.

readonly object IEnumerator.Current { get; }

Returns

object

The element in the collection at the current position of the enumerator.

Applies to

Product	Versions
.NET	8, 10