Struct Storage.DirectoryEnumerable

Namespace

Sdl3Sharp.IO

Assembly

Sdl3Sharp.dll

Represents an enumerable collection of entries for a specified directory path within a storage container

public readonly struct Storage.DirectoryEnumerable : IEnumerable<string>, IEnumerable

Implements

IEnumerable<string>

IEnumerable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

If path is null or the empty string (""), this is treated as a request to enumerate the root of the storage container.

Constructors

DirectoryEnumerable(Storage, string?)

Represents an enumerable collection of entries for a specified directory path within a storage container

public DirectoryEnumerable(Storage storage, string? path)

Parameters

storage Storage

The storage container to enumerate

path string

The path to the directory to enumerate, or null or the empty string ("") to request the root of the storage container

Remarks

If path is null or the empty string (""), this is treated as a request to enumerate the root of the storage container.

Exceptions

ArgumentNullException

storage is null

Methods

GetEnumerator()

Gets an enumerator that enumerates through the entries for this Storage.DirectoryEnumerable

public Storage.DirectoryEnumerable.Enumerator GetEnumerator()

Returns

Storage.DirectoryEnumerable.Enumerator

An Storage.DirectoryEnumerable.Enumerator that can be used to enumerate the entries for this Storage.DirectoryEnumerable

Exceptions

SdlException

Couldn't create an Storage.DirectoryEnumerable.Enumerator for this Storage.DirectoryEnumerable (check TryGet(out string?) for more information)