Interface IFileSystem

Represents a file system.

Namespace: Evergine.Common.IO
Assembly: Evergine.Common.dll
Syntax
public interface IFileSystem

Methods

EnumerateDirectories(string, string, SearchOption)

Returns an enumerable collection of subdirectories that match the specified search pattern in the specified full path in the assets directory and optionally searches subdirectories.

Declaration
IEnumerable<string> EnumerateDirectories(string path, string searchPattern, SearchOption searchOption)
Parameters
Type Name Description
string path

The full path in the assets directory.
string searchPattern

The search string to match against the names of files in the path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
SearchOption searchOption

One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.
Returns
Type Description
IEnumerable<string>

An enumerable collection of subdirectories in the specified full path in the assets directory that match the specified criteria, or an empty enumerable collection if no directories are found.
Remarks

If an existing directory is empty, it will be discarded from the enumerable collection.

EnumerateFiles(string, string, SearchOption)

Returns the names of files that match the specified search pattern in the specified full path in the assets directory, and optionally searches subdirectories.

Declaration
IEnumerable<string> EnumerateFiles(string path, string searchPattern, SearchOption searchOption)
Parameters
Type Name Description
string path

The full path in the assets directory.
string searchPattern

The search string to match against the names of files in the path. This parameter can contain a combination of valid literal path and wildcard (* and ?) characters, but it doesn't support regular expressions.
SearchOption searchOption

One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.
Returns
Type Description
IEnumerable<string>

An enumerable collection of names for the files in the specified full path in the assets directory that match the specified criteria, or an empty enumerable collection if no files are found.

Exists(string)

Determines whether the specified asset file exists.

Declaration
bool Exists(string path)
Parameters
Type Name Description
string path

The asset file path to check.
Returns
Type Description
bool

true if the assets directory contains the specified file; otherwise, false.

Open(string)

Opens the specified asset file.

Declaration
AssetStream Open(string path)
Parameters
Type Name Description
string path

The full path to the asset file.
Returns
Type Description
AssetStream

The result.

Extension Methods