WeekPattern.Enumerator Struct

Definition

Namespace

Bodu

Assembly

Bodu.Core.dll

Package

Bodu.Core 1.0.1

Source

WeekPattern.Enumerator.cs

Enumerates the selected days of a WeekPattern in Sunday-first order without allocating.

public struct WeekPattern.Enumerator : IEnumerator<DayOfWeek>, IEnumerator, IDisposable

Implements

IEnumerator<DayOfWeek>

IEnumerator

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

BufferConverter.CopyTo<T>(T, byte[], int)

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

Returned by GetEnumerator() and bound directly by the C# foreach pattern, so iterating a WeekPattern requires no heap allocation. Accessing the enumerator through IEnumerator<T> or IEnumerator boxes this struct as a one-off cost.

The enumerator captures the underlying bitmask at construction; the source WeekPattern is a value type and immutable, so the snapshot semantics are exact.

Properties

Current

Gets the DayOfWeek at the current position of the enumerator.

public readonly DayOfWeek Current { get; }

Property Value

DayOfWeek

The day yielded by the most recent successful MoveNext() call.

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 selected day.

public bool MoveNext()

Returns

bool

true when a further selected day is available and Current has been updated; false when the enumerator has passed the end of the pattern.

Reset()

Resets the enumerator to its initial position, before the first selected day.

public void 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