AgateLib.IFileProvider Interface Reference
Public interface that should be implemented. More...
Public Member Functions | |
| Stream | OpenRead (string filename) |
| Opens the specified file returning a stream. Throws FileNotFoundException if the file does not exist. | |
| bool | FileExists (string filename) |
| Checks to if the specified file exists in the file provider. | |
| IEnumerable< string > | GetAllFiles () |
| Enumerates through all filenames in the file provider. | |
| IEnumerable< string > | GetAllFiles (string searchPattern) |
| Enumerates through all filenames which match the specified search pattern. | |
Detailed Description
Public interface that should be implemented.
Member Function Documentation
| bool AgateLib.IFileProvider.FileExists | ( | string | filename | ) |
Checks to if the specified file exists in the file provider.
- Parameters:
-
filename
- Returns:
Implemented in AgateLib.Utility.FileProviderList, AgateLib.Utility.FileSystemProvider, AgateLib.Utility.TgzFileProvider, and AgateLib.Utility.ZipFileProvider.
| IEnumerable<string> AgateLib.IFileProvider.GetAllFiles | ( | string | searchPattern | ) |
Enumerates through all filenames which match the specified search pattern.
The search pattern is not regex style pattern matching, rather it should be bash pattern matching, so a searchPattern of "*" would match all files, and "*.*" would match all filenames with a period in them.
- Parameters:
-
searchPattern
- Returns:
Implemented in AgateLib.Utility.FileProviderList, AgateLib.Utility.FileSystemProvider, AgateLib.Utility.TgzFileProvider, and AgateLib.Utility.ZipFileProvider.
| IEnumerable<string> AgateLib.IFileProvider.GetAllFiles | ( | ) |
Enumerates through all filenames in the file provider.
- Returns:
Implemented in AgateLib.Utility.FileProviderList, AgateLib.Utility.FileSystemProvider, AgateLib.Utility.TgzFileProvider, and AgateLib.Utility.ZipFileProvider.
| Stream AgateLib.IFileProvider.OpenRead | ( | string | filename | ) |
Opens the specified file returning a stream. Throws FileNotFoundException if the file does not exist.
- Parameters:
-
filename
- Returns:
Implemented in AgateLib.Utility.FileProviderList, AgateLib.Utility.FileSystemProvider, AgateLib.Utility.TgzFileProvider, and AgateLib.Utility.ZipFileProvider.
The documentation for this interface was generated from the following file:
- IFileProvider.cs
