Struct FileSystem.DirectoryEnumerable.Enumerator

Namespace

Sdl3Sharp.IO

Assembly

Sdl3Sharp.dll

Enumerates files system entries in a directory specified by a FileSystem.DirectoryEnumerable instance

public struct FileSystem.DirectoryEnumerable.Enumerator : IEnumerator<string>, IEnumerator, IDisposable

Implements

IEnumerator<string>

IEnumerator

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Current

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

public readonly string Current { get; }

Property Value

string

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

TryCreate(DirectoryEnumerable, out Enumerator)

Tries to create a new FileSystem.DirectoryEnumerable.Enumerator for a specified FileSystem.DirectoryEnumerable

public static bool TryCreate(FileSystem.DirectoryEnumerable enumerable, out FileSystem.DirectoryEnumerable.Enumerator enumerator)

Parameters

enumerable FileSystem.DirectoryEnumerable

The FileSystem.DirectoryEnumerable to enumerate

enumerator FileSystem.DirectoryEnumerable.Enumerator

The newly created enumerator for the FileSystem.DirectoryEnumerable, when this method returns true; otherwise, default(FileSystem.DirectoryEnumerable.Enumerator)

Returns

bool

true, if the enumerator was created successfully; otherwise, false (check TryGet(out string?) for more information)

Remarks

Note: The actual enumeration of the directory entries is performed during the call to this method.