IReadOnlyFileSystem Interface

Summary

Represents a file system.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.IO
Implementing Types
graph BT Type["IReadOnlyFileSystem"] class Type type-node Implementing0["TestFileSystem"]-.->Type click Implementing0 "/api/Wyam.Testing.IO/TestFileSystem" Implementing1["IFileSystem"]-.->Type click Implementing1 "/api/Wyam.Common.IO/IFileSystem"

Syntax

public interface IReadOnlyFileSystem

Properties

Name Value Summary
FileProviders IReadOnlyFileProviderCollection
Gets the file providers.
InputPaths IReadOnlyList<DirectoryPath>
Gets the input paths. These are searched in reverse order for files and directories. For example, given input paths "A", "B", and "C" in that order, "C" will be checked for a requested file or directory first, and then if it doesn't exist in "C", "B" will be checked, and then "A". If none of the input paths contain the requested file or directory, the last input path (in this case, "C") will be used as the location of the requested non-existent file or directory. If you attempt to create it at this point, it will be created under path "C".
OutputPath DirectoryPath
Gets the output path.
RootPath DirectoryPath
Gets the root path.
TempPath DirectoryPath
Gets the temporary file path.

Methods

Name Value Summary
GetContainingInputPath(NormalizedPath) DirectoryPath
Gets the absolute input path that contains the specified file or directory. If the provided file or directory path is absolute, this returns the input path that contains the specified path (note that the specified file or directory does not need to exist and this just returns the input path that would contain the file or directory based only on path information). If the provided path is relative, this checks all input paths for the existence of the file or directory and returns the first one where it exists.
GetDirectory(DirectoryPath) IDirectory
Gets an absolute directory.
GetFile(FilePath) IFile
Gets an absolute file.
GetFileProvider(NormalizedPath) IFileProvider
Gets the registered file provider for a specified path.
GetFiles(IDirectory, IEnumerable<string>) IEnumerable<IFile>
Gets matching files based on globbing patterns and/or absolute paths. If any absolute paths are provided, only those that actually exist are returned.
GetFiles(IDirectory, string[]) IEnumerable<IFile>
Gets matching files based on globbing patterns and/or absolute paths. If any absolute paths are provided, only those that actually exist are returned.
GetFiles(IEnumerable<string>) IEnumerable<IFile>
Gets matching files based on globbing patterns from the root path or absolute paths.
GetFiles(string[]) IEnumerable<IFile>
Gets matching files based on globbing patterns from the root path or absolute paths.
GetInputDirectories() IReadOnlyList<IDirectory>
Gets all absolute input directories.
GetInputDirectory(DirectoryPath) IDirectory
Gets a directory representing an input.
GetInputFile(FilePath) IFile
Gets a file representing an input.
GetInputFiles(IEnumerable<string>) IEnumerable<IFile>
Gets matching input files based on globbing patterns and/or absolute paths. If any absolute paths are provided, only those that actually exist are returned.
GetInputFiles(string[]) IEnumerable<IFile>
Gets matching input files based on globbing patterns and/or absolute paths. If any absolute paths are provided, only those that actually exist are returned.
GetOutputDirectory(DirectoryPath) IDirectory
Gets a directory representing an output.
GetOutputFile(FilePath) IFile
Gets a file representing an output.
GetOutputPath(DirectoryPath) DirectoryPath
Gets an output directory path by combining it with the root path and output path.
GetOutputPath(FilePath) FilePath
Gets an output file path by combining it with the root path and output path.
GetRootDirectory(DirectoryPath) IDirectory
Gets a directory representing a root directory.
GetRootFile(FilePath) IFile
Gets a file representing a root file.
GetTempDirectory(DirectoryPath) IDirectory
Gets a directory representing temp files.
GetTempFile() IFile
Gets a file representing a temp file with a random file name.
GetTempFile(FilePath) IFile
Gets a file representing a temp file.
GetTempPath(DirectoryPath) DirectoryPath
Gets a temp directory path by combining it with the root path and temp path.
GetTempPath(FilePath) FilePath
Gets a temp file path by combining it with the root path and temp path.
GitHub