A file system that can be configured.
- Namespace
- Statiq
.Common - Interfaces
- Implementing Types
graph BT
Type-.->Interface0["IReadOnlyFileSystem"]
click Interface0 "/api/Statiq.Common/IReadOnlyFileSystem"
Type["IFileSystem"]
class Type type-node
Implementing0["TestFileSystem"]-.->Type
click Implementing0 "/api/Statiq.Testing/TestFileSystem"
Implementing1["FileSystem"]-.->Type
click Implementing1 "/api/Statiq.Core/FileSystem"
Syntax
public interface IFileSystem : IReadOnlyFileSystemProperties
| Name | Property Type | Summary |
|---|---|---|
| CachePath | NormalizedPath |
Gets or sets the cache file path.
|
| ExcludedPaths | PathCollection |
Gets the excluded paths collection which can be used
to excluded specific paths from the input paths. Any
IDirectory or IFile within
an excluded path will appear to be non-existing.
|
| FileProvider | IFileProvider |
Gets the file provider.
|
| InputPathMappings | IDictionary |
Gets the input path mapping dictionary which can be used
to add or remove input path mappings.
|
| InputPaths | PathCollection |
Gets the input paths collection which can be used
to add or remove input paths.
|
| OutputPath | NormalizedPath |
Gets or sets the output path.
|
| RootPath | NormalizedPath |
Gets or sets the root path.
|
| TempPath | NormalizedPath |
Gets or sets the temporary file path.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| GetCacheDirectory |
IDirectory |
Gets a directory representing cache files.
|
| GetCacheDirectory |
IDirectory |
Gets a directory representing cache files.
|
| GetCacheFile |
IFile |
Gets a file representing a cache file.
|
| GetCacheFile |
IFile |
Gets a file representing a cache file with a random file name.
|
| GetCachePath |
NormalizedPath |
Gets a cache path by combining it with the root path and cache path.
|
| GetCachePath |
NormalizedPath |
Gets the cache path.
|
| Get |
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.
|
| GetDirectory |
IDirectory |
Gets an absolute directory.
|
| GetFile |
IFile |
Gets an absolute file.
|
| GetFiles |
IEnumerable |
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 |
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 |
Gets matching files based on globbing patterns from the root path or absolute paths.
|
| GetFiles |
IEnumerable |
Gets matching files based on globbing patterns from the root path or absolute paths.
|
| GetInputDirectories |
IEnumerable |
Gets all absolute input directories.
|
| GetInputDirectory |
IDirectory |
Gets a directory representing an input.
|
| GetInputDirectory |
IDirectory |
Gets the root virtual input directory.
|
| GetInputFile |
IFile |
Gets a file representing an input.
|
| GetInputFiles |
IEnumerable |
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 |
IEnumerable |
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 |
IDirectory |
Gets a directory representing an output.
|
| GetOutputDirectory |
IDirectory |
Gets a directory representing an output.
|
| GetOutputFile |
IFile |
Gets a file representing an output.
|
| GetOutputPath |
NormalizedPath |
Gets an output path by combining it with the root path and output path.
|
| GetOutputPath |
NormalizedPath |
Gets the output path.
|
| GetRelativeInputPath |
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.
|
| Get |
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.
|
| Get |
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.
|
| GetRootDirectory |
IDirectory |
Gets a directory representing a root directory.
|
| GetRootDirectory |
IDirectory |
Gets a directory representing a root directory.
|
| GetRootFile |
IFile |
Gets a file representing a root file.
|
| GetRootPath |
NormalizedPath |
Gets a path by combining it with the root path.
|
| GetRootPath |
NormalizedPath |
Gets the root path.
|
| GetTempDirectory |
IDirectory |
Gets a directory representing temp files.
|
| GetTempDirectory |
IDirectory |
Gets a directory representing temp files.
|
| GetTempFile |
IFile |
Gets a file representing a temp file.
|
| GetTempFile |
IFile |
Gets a file representing a temp file with a random file name.
|
| GetTempPath |
NormalizedPath |
Gets a temp path by combining it with the root path and temp path.
|
| GetTempPath |
NormalizedPath |
Gets the temp path.
|
| Get |
IEnumerable |
Given a relative input path this "unmaps" it for each input path.
|
| ThrowIfNull |
T |
From GuardExtensions
|
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument |