IReadOnlyFileSystemExtensions Class
Namespace
Statiq.Common
Base Types
  • object
graph BT Type-->Base0["object"] Type["IReadOnlyFileSystemExtensions"] class Type type-node

Syntax

public static class IReadOnlyFileSystemExtensions

Methods

Name Return Value Summary
GetCacheDirectory(IReadOnlyFileSystem, NormalizedPath) IDirectory
Gets a directory representing cache files.
static
GetCacheDirectory(IReadOnlyFileSystem) IDirectory
Gets a directory representing cache files.
static
GetCacheFile(IReadOnlyFileSystem, NormalizedPath) IFile
Gets a file representing a cache file.
static
GetCacheFile(IReadOnlyFileSystem) IFile
Gets a file representing a cache file with a random file name.
static
GetCachePath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets a cache path by combining it with the root path and cache path.
static
GetCachePath(IReadOnlyFileSystem) NormalizedPath
Gets the cache path.
static
GetContainingInputPath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
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.
static
GetDirectory(IReadOnlyFileSystem, NormalizedPath) IDirectory
Gets an absolute directory.
static
GetFile(IReadOnlyFileSystem, NormalizedPath) IFile
Gets an absolute file.
static
GetFiles(IReadOnlyFileSystem, 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.
static
GetFiles(IReadOnlyFileSystem, 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.
static
GetFiles(IReadOnlyFileSystem, IEnumerable<string>) IEnumerable<IFile>
Gets matching files based on globbing patterns from the root path or absolute paths.
static
GetFiles(IReadOnlyFileSystem, string[]) IEnumerable<IFile>
Gets matching files based on globbing patterns from the root path or absolute paths.
static
GetInputDirectories(IReadOnlyFileSystem) IEnumerable<IDirectory>
Gets all absolute input directories.
static
GetInputDirectory(IReadOnlyFileSystem, NormalizedPath) IDirectory
Gets a directory representing an input.
static
GetInputDirectory(IReadOnlyFileSystem) IDirectory
Gets the root virtual input directory.
static
GetInputFile(IReadOnlyFileSystem, NormalizedPath) IFile
Gets a file representing an input.
static
GetInputFiles(IReadOnlyFileSystem, 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.
static
GetInputFiles(IReadOnlyFileSystem, 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.
static
GetOutputDirectory(IReadOnlyFileSystem, NormalizedPath) IDirectory
Gets a directory representing an output.
static
GetOutputDirectory(IReadOnlyFileSystem) IDirectory
Gets a directory representing an output.
static
GetOutputFile(IReadOnlyFileSystem, NormalizedPath) IFile
Gets a file representing an output.
static
GetOutputPath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets an output path by combining it with the root path and output path.
static
GetOutputPath(IReadOnlyFileSystem) NormalizedPath
Gets the output path.
static
GetRelativeInputPath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets a path to the specified file relative to it's containing input directory. If no input directories contain this file, then a null path is returned.
static
GetRelativeOutputPath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets a path to the specified file relative to the output directory. If this path is not relative to the output directory, then a null path is returned.
static
GetRelativeOutputPathOrSelf(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets a path to the specified file relative to the output directory. If this path is not relative to the output directory, then the original path is returned.
static
GetRootDirectory(IReadOnlyFileSystem, NormalizedPath) IDirectory
Gets a directory representing a root directory.
static
GetRootDirectory(IReadOnlyFileSystem) IDirectory
Gets a directory representing a root directory.
static
GetRootFile(IReadOnlyFileSystem, NormalizedPath) IFile
Gets a file representing a root file.
static
GetRootPath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets a path by combining it with the root path.
static
GetRootPath(IReadOnlyFileSystem) NormalizedPath
Gets the root path.
static
GetTempDirectory(IReadOnlyFileSystem, NormalizedPath) IDirectory
Gets a directory representing temp files.
static
GetTempDirectory(IReadOnlyFileSystem) IDirectory
Gets a directory representing temp files.
static
GetTempFile(IReadOnlyFileSystem, NormalizedPath) IFile
Gets a file representing a temp file.
static
GetTempFile(IReadOnlyFileSystem) IFile
Gets a file representing a temp file with a random file name.
static
GetTempPath(IReadOnlyFileSystem, NormalizedPath) NormalizedPath
Gets a temp path by combining it with the root path and temp path.
static
GetTempPath(IReadOnlyFileSystem) NormalizedPath
Gets the temp path.
static
GetUnmappedInputPaths(IReadOnlyFileSystem, NormalizedPath, HashSet<NormalizedPath>) IEnumerable<NormalizedPath>
Given a relative input path this "unmaps" it for each input path.
static