VFSIndex.md
January 20, 2026 · View on GitHub
Atypical.VirtualFileSystem.Core
Atypical.VirtualFileSystem.Core
VFSIndex Class
Represents the index of the virtual file system.
public sealed class VFSIndex
Inheritance System.Object 🡒 VFSIndex
Remarks
The vfs index is a dictionary of vfs paths and vfs nodes. The vfs index is used to store the nodes of the virtual file system. The vfs index is sorted by the vfs paths. The vfs index is case insensitive. This class cannot be inherited.
| Properties | |
|---|---|
| Count | Gets the total count of nodes in the index. |
| Directories | Gets the directories in the index. |
| DirectoriesCount | Gets the count of directories in the index. |
| Files | Gets the files in the index. |
| FilesCount | Gets the count of files in the index. |
| IsEmpty | Gets a value indicating whether the index is empty. |
| Keys | Gets the keys of the raw index. |
| RawIndex | Gets the raw index of the virtual file system. |
| this[VFSDirectoryPath] | Gets or sets the node at the specified directory path. |
| this[VFSFilePath] | Gets or sets the node at the specified file path. |
| Values | Gets the values of the raw index. |
| Methods | |
|---|---|
| ContainsKey(VFSPath) | Determines whether the index contains the specified key. |
| GetDirectory(VFSDirectoryPath) | Gets the directory node at the specified directory path. |
| GetFile(VFSFilePath) | Gets the file node at the specified file path. |
| GetPathsStartingWith(VFSDirectoryPath) | Gets the paths starting with the specified directory path. |
| Remove(VFSPath) | Removes the node with the specified key. |
| ToString() | Returns a string that represents the current object. |
| TryAdd(VFSPath, IVirtualFileSystemNode) | Tries to add the specified node to the index. |
| TryGetDirectory(VFSDirectoryPath, IDirectoryNode) | Tries to get the directory node at the specified directory path. |
| TryGetFile(VFSFilePath, IFileNode) | Tries to get the file node at the specified file path. |